diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ca816b1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +build/ +DS_Store + 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/Makefile b/Makefile new file mode 100644 index 0000000..d29cf74 --- /dev/null +++ b/Makefile @@ -0,0 +1,31 @@ +UNAME := $(shell uname -o) + +ifeq ($(UNAME),GNU/Linux) + VINCI_SRC = vinci-xcb.c + EXTRAOPTIONS = -lxcb +else ifeq ($(UNAME),Msys) + VINCI_SRC = vinci-win32.c + EXTRAOPTIONS = -mwindows +else ifeq ($(UNAME),Darwin) + VINCI_SRC = vinci-cocoa.m + EXTRAOPTIONS = -framework Cocoa -lobjc +endif + +CC = gcc +CFLAGS = -std=c99 -O3 +STRICT = -Wall -Wextra -pedantic -Wmissing-prototypes -Wstrict-prototypes -Wold-style-definition -Wuninitialized -Wmissing-declarations + +BUILD_DIR = build + +all: $(BUILD_DIR)/test + +$(BUILD_DIR): + mkdir -p $(BUILD_DIR) + +$(BUILD_DIR)/test: test.c $(VINCI_SRC) | $(BUILD_DIR) + $(CC) $(CFLAGS) $(STRICT) $(VINCI_SRC) test.c -o $@ $(EXTRAOPTIONS) + +clean: + rm -rf $(BUILD_DIR) + +.PHONY: all clean \ No newline at end of file diff --git a/README.md b/README.md index e69de29..7089c04 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,23 @@ +# Vinci - Cross-Platform Windowing Library + +Refer to `vinci.h` and `test.c` to get started with the API. + +## Supported Platforms +- Linux (via XCB) +- Windows (Win32) +- macOS (Cocoa) + +## Status +- Unstable +- Undocumented +- API might change + +## Building +Run `make` to build the test program. + +## Legal +Copyright (C) 2025 Orastron Srl unipersonale. + +Authors: Stefano D'Angelo, Paolo Marrone. + +All the code in the repo is released under GPLv3. See the LICENSE file. diff --git a/test.c b/test.c new file mode 100644 index 0000000..0c5f70a --- /dev/null +++ b/test.c @@ -0,0 +1,96 @@ +/* + * Vinci + * + * Copyright (C) 2025 Orastron Srl unipersonale + * + * Vinci 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, version 3 of the License. + * + * Vinci 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 Vinci. If not, see . + * + * File author: Paolo Marrone + */ + +#include "vinci.h" + +#include +#include + +vinci *g; +window *w1, *w2; + +static void on_close(window *w) { + printf("on_close %p \n", (void*)w); fflush(stdout); + window_free(w); + if (w == w1) { + w1 = NULL; + if (!w2) + vinci_stop(g); + } + if (w == w2) { + w2 = NULL; + if (!w1) + vinci_stop(g); + } +} + +static void on_mouse_press (window *w, int32_t x, int32_t y, uint32_t state) { + printf("on_mouse_press %p %d %d %u \n", (void*)w, x, y, state); +} + +static void on_mouse_release (window *w, int32_t x, int32_t y, uint32_t state) { + printf("on_mouse_release %p %d %d %u \n", (void*)w, x, y, state); +} + +static void on_mouse_move (window *w, int32_t x, int32_t y, uint32_t state) { + printf("on_mouse_move %p %d %d %u \n", (void*)w, x, y, state); +} + +static void on_window_resize (window *w, int32_t width, int32_t height) { + printf("on_window_resize %p %d %d \n", (void*) w, width, height); +} + +int main (void) { + + // Vinci init + g = vinci_new(); + // TODO: check for errors + + // w1 + struct window_cbs w1cbs; + memset(&w1cbs, 0, sizeof(window_cbs)); + w1cbs.on_window_close = on_close; + w1cbs.on_mouse_press = on_mouse_press; + w1cbs.on_mouse_release = on_mouse_release; + w1cbs.on_mouse_move = on_mouse_move; + w1cbs.on_window_resize = on_window_resize; + + w1 = window_new(g, NULL, 300, 500, &w1cbs); + on_window_resize(w1, window_get_width(w1), window_get_height(w1)); // This is needed for x only + window_show(w1); + + // w2 + + struct window_cbs w2cbs; + memset(&w2cbs, 0, sizeof(window_cbs)); + w2cbs.on_window_close = on_close; + w2cbs.on_mouse_press = on_mouse_press; + w2cbs.on_mouse_release = on_mouse_release; + w2cbs.on_mouse_move = on_mouse_move; + w2cbs.on_window_resize = on_window_resize; + + w2 = window_new(g, NULL, 500, 500, &w2cbs); + on_window_resize(w2, window_get_width(w2), window_get_height(w2)); + window_show(w2); + + vinci_run(g, 0); + + vinci_destroy(g); +} \ No newline at end of file diff --git a/vinci-win32.c b/vinci-win32.c new file mode 100644 index 0000000..cb1cfb3 --- /dev/null +++ b/vinci-win32.c @@ -0,0 +1,355 @@ +/* + * Vinci + * + * Copyright (C) 2025 Orastron Srl unipersonale + * + * Vinci 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, version 3 of the License. + * + * Vinci 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 Vinci. If not, see . + * + * File author: Paolo Marrone, Stefano D'Angelo + */ + +#include "vinci.h" + +#include +#include +#include + +struct window { + vinci *g; + window *next; + HWND handle; + HBITMAP bitmap; + BITMAPINFOHEADER bitmap_info; + uint8_t *bgra; + char mouse_tracking; + void *data; + window_cbs cbs; +}; + +struct vinci { + char keep_running; + window *windows; + char className[20]; +}; + +static uint32_t get_mouse_state(WPARAM wParam) { + return (wParam & (MK_LBUTTON | MK_RBUTTON)) | ((wParam & MK_MBUTTON) >> 2); +} + +static LRESULT CALLBACK WndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam) { + window *w = (window*) GetWindowLongPtrA(hwnd, 0); + if (w == NULL) + return DefWindowProc(hwnd, msg, wParam, lParam); + + POINTS points; + switch(msg) + { + case WM_LBUTTONDOWN: + case WM_MBUTTONDOWN: + case WM_RBUTTONDOWN: + if (w->cbs.on_mouse_press) { + points = MAKEPOINTS(lParam); + SetCapture(hwnd); + w->cbs.on_mouse_press(w, points.x, points.y, get_mouse_state(wParam)); + } + break; + case WM_LBUTTONUP: + case WM_MBUTTONUP: + case WM_RBUTTONUP: + if (w->cbs.on_mouse_release) { + points = MAKEPOINTS(lParam); + if (get_mouse_state(wParam) == 0) { + ReleaseCapture(); + } + w->cbs.on_mouse_release(w, points.x, points.y, get_mouse_state(wParam)); + } + break; + case WM_MOUSEMOVE: + points = MAKEPOINTS(lParam); + if (!w->mouse_tracking) { + if (w->cbs.on_mouse_enter) + w->cbs.on_mouse_enter(w, points.x, points.y, 1); + TRACKMOUSEEVENT tme; + tme.cbSize = sizeof(tme); + tme.hwndTrack = hwnd; + tme.dwFlags = TME_HOVER | TME_LEAVE; + tme.dwHoverTime = HOVER_DEFAULT; + TrackMouseEvent(&tme); + w->mouse_tracking = 1; + } + if (w->cbs.on_mouse_move) + w->cbs.on_mouse_move(w, points.x, points.y, get_mouse_state(wParam)); + break; + case WM_MOUSELEAVE: + w->mouse_tracking = 0; + if (w->cbs.on_mouse_leave) { + points = MAKEPOINTS(lParam); + w->cbs.on_mouse_leave(w, points.x, points.y, get_mouse_state(wParam)); + } + break; + case WM_KEYDOWN: + if (w->cbs.on_key_press) + w->cbs.on_key_press(w, wParam, 1); + break; + case WM_KEYUP: + if (w->cbs.on_key_release) + w->cbs.on_key_release(w, wParam, 1); + break; + case WM_SIZE: + { + const uint32_t width = LOWORD(lParam); + const uint32_t height = HIWORD(lParam); + DeleteObject(w->bitmap); + w->bitmap_info.biWidth = width; + w->bitmap_info.biHeight = -height; + HDC dc = GetDC(w->handle); + w->bitmap = CreateDIBSection(dc, (BITMAPINFO*)&w->bitmap_info, DIB_RGB_COLORS, (void **)&w->bgra, NULL, 0); + ReleaseDC(w->handle, dc); + if (w->cbs.on_window_resize) + w->cbs.on_window_resize(w, width, height); + } + break; + case WM_PAINT: + { + RECT cr;; + GetClientRect(w->handle, &cr); + RECT r; + if (GetUpdateRect(hwnd, &r, 0)) { + PAINTSTRUCT ps; + HDC dc = BeginPaint(hwnd, &ps); + SetDIBitsToDevice(dc, r.left, r.top, r.right - r.left, r.bottom - r.top, r.left, cr.bottom - cr.top - r.bottom, 0, -w->bitmap_info.biHeight, w->bgra, (BITMAPINFO*)&w->bitmap_info, DIB_RGB_COLORS); + EndPaint(hwnd, &ps); + } + } + break; + case WM_DESTROY: + { + if (w->cbs.on_window_close) + w->cbs.on_window_close(w); + } + break; + } + return DefWindowProc(hwnd, msg, wParam, lParam); +} + +vinci* vinci_new(void) { + vinci *g = (vinci*)malloc(sizeof(vinci)); + if (!g) + return NULL; + snprintf(g->className, 20, "vinClass%p", (void*)g); // Nice random name + + WNDCLASSEX wc; + wc.cbSize = sizeof(WNDCLASSEX); + wc.style = 0; + wc.lpfnWndProc = WndProc; + wc.cbClsExtra = 0; + wc.cbWndExtra = sizeof (window*); // To store window ptr into hwnd + wc.hInstance = NULL; + wc.hIcon = LoadIcon(NULL, IDI_APPLICATION); + wc.hCursor = LoadCursor(NULL, IDC_ARROW); + wc.hbrBackground = (HBRUSH)(WHITE_BRUSH); + wc.lpszMenuName = NULL; + wc.lpszClassName = g->className; + wc.hIconSm = LoadIcon(NULL, IDI_APPLICATION); + if (!RegisterClassEx(&wc)) { + free(g); + return NULL; + } + g->keep_running = 0; + g->windows = NULL; + return g; +} + +void vinci_destroy(vinci *g) { + UnregisterClass(g->className, NULL); + free(g); +} + +void vinci_run(vinci *g, char single) { + g->keep_running = 1; + MSG msg; + while (g->keep_running) { + if (single) { + BOOL b = PeekMessage(&msg, NULL, 0, 0, PM_REMOVE); + if (!b) + break; + } else { + BOOL b = GetMessage(&msg, NULL, 0, 0); + if (b <= 0) + break; + } + TranslateMessage(&msg); + DispatchMessage(&msg); + } +} + +void vinci_stop(vinci *g) { + g->keep_running = 0; +} + +window* window_new(vinci *g, void* parent, uint32_t width, uint32_t height, window_cbs *cbs) { + window *w = (window*)malloc(sizeof(window)); + if (w == NULL) + return NULL; + + w->g = g; + w->handle = CreateWindowEx(0, g->className, NULL, WS_OVERLAPPEDWINDOW, CW_USEDEFAULT, CW_USEDEFAULT, width, height, NULL, NULL, NULL, NULL); + if (w->handle == NULL) { + free(w); + return NULL; + } + SetWindowLongPtrW(w->handle, 0, (LONG_PTR) w); + ZeroMemory(&w->bitmap_info, sizeof(BITMAPINFOHEADER)); + w->bitmap_info.biSize = sizeof(BITMAPINFOHEADER); + w->bitmap_info.biWidth = width; + w->bitmap_info.biHeight = -height; + w->bitmap_info.biPlanes = 1; + w->bitmap_info.biBitCount = 32; + w->bitmap_info.biCompression = BI_RGB; + HDC dc = GetDC(w->handle); + w->bitmap = CreateDIBSection(dc, (BITMAPINFO*)&w->bitmap_info, DIB_RGB_COLORS, (void **)&w->bgra, NULL, 0); + ReleaseDC(w->handle, dc); + if (w->bitmap == NULL) { + DestroyWindow(w->handle); + free(w); + return NULL; + } + + if (parent) { + SetParent(w->handle, *((HWND *)parent)); + SetWindowLong(w->handle, GWL_STYLE, GetWindowLong(w->handle, GWL_STYLE) & ~(WS_BORDER | WS_SIZEBOX | WS_DLGFRAME)); + SetWindowPos(w->handle, HWND_TOP, 0, 0, 0, 0, SWP_NOSIZE | SWP_NOZORDER | SWP_FRAMECHANGED); // SWP_FRAMECHANGED triggers WndProc call with WM_SIZE right here. May they die hard + } + + w->next = NULL; + if (g->windows == NULL) + g->windows = w; + else { + window *n = g->windows; + while (n->next) + n = n->next; + n->next = w; + } + + TRACKMOUSEEVENT tme; + tme.cbSize = sizeof(TRACKMOUSEEVENT); + tme.dwFlags = TME_LEAVE; + tme.hwndTrack = w->handle; + TrackMouseEvent(&tme); + w->mouse_tracking = 1; + + w->data = NULL; + w->cbs = *cbs; + UpdateWindow(w->handle); + + return w; +} + +void window_free(window *w) { + if (w->g->windows == w) + w->g->windows = w->next; + else { + window *n = w->g->windows; + while (n->next != w) + n = n->next; + n->next = w->next; + } + DeleteObject(w->bitmap); + //DestroyWindow(w->handle); // This calls WM_DESTROY. So this should used to actively close a window, not as a cb + free(w); +} + +static inline int mini(int a, int b) { + return a < b ? a : b; +} + +static inline int maxi(int a, int b) { + return a > b ? a : b; +} + +void window_draw(window *w, unsigned char *data, int32_t dx, int32_t dy, int32_t dw, int32_t dh, int32_t wx, int32_t wy, int32_t width, int32_t height) { + (void) dh; + + RECT cr; + GetClientRect(w->handle, &cr); + + const int wx_ = maxi(wx, cr.left); + const int wy_ = maxi(wy, cr.top); + const int width_ = mini(width - (wx_ - wx), cr.right - wx); + const int height_ = mini(height - (wy_ - wy), cr.bottom - wy); + if (width_ <= 0 || height_ <= 0 ) + return; + dx = dx + (wx_ - wx); + dy = dy + (wy_ - wy); + wx = wx_; + wy = wy_; + width = width_; + height = height_; + + uint32_t *src = ((uint32_t *)data) + dw * dy + dx; + uint32_t *dest = ((uint32_t *)w->bgra) + w->bitmap_info.biWidth * wy + wx; + for (uint32_t h = height; h; h--, src += dw, dest += w->bitmap_info.biWidth) { + //memcpy(dest, src, 4 * width); + for (int32_t x = 0; x < width; x++) // TODO: BIG ENDIAN AND LITTLEENDIAN IFDEF + dest[x] = ((src[x] >> 16) & 0x00000000ff) | ((src[x]) & 0x0000ff00) | ((src[x] << 16) & 0x00ff0000); + } + + RECT r = { + wx, // left + wy, // top + wx + width, // right + wy + height // bottom + }; + + RedrawWindow(w->handle, &r, NULL, RDW_INVALIDATE | RDW_UPDATENOW); +} + +void window_resize(window *w, uint32_t width, uint32_t height) { + SetWindowPos(w->handle, NULL, 0, 0, width, height, SWP_NOMOVE | SWP_NOZORDER); +} + +void window_move(window *w, uint32_t x, uint32_t y) { + SetWindowPos(w->handle, NULL, x, y, 0, 0, SWP_NOSIZE | SWP_NOZORDER); +} + +uint32_t window_get_width(window *w) { + RECT r; + GetClientRect(w->handle, &r); + return r.right - r.left; +} + +uint32_t window_get_height(window *w) { + RECT r; + GetClientRect(w->handle, &r); + return r.bottom - r.top; +} + +void *window_get_handle(window *w) { + return w->handle; +} + +void window_show(window *w) { + ShowWindow(w->handle, SW_SHOW); +} + +void window_hide(window *w) { + ShowWindow(w->handle, SW_HIDE); +} + +void window_set_data(window *w, void *data) { + w->data = data; +} + +void *window_get_data(window *w) { + return w->data; +} diff --git a/vinci-xcb.c b/vinci-xcb.c new file mode 100644 index 0000000..ccf05c5 --- /dev/null +++ b/vinci-xcb.c @@ -0,0 +1,478 @@ +/* + * Vinci + * + * Copyright (C) 2025 Orastron Srl unipersonale + * + * Vinci 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, version 3 of the License. + * + * Vinci 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 Vinci. If not, see . + * + * File author: Stefano D'Angelo, Paolo Marrone + */ + +#include "vinci.h" + +#include +#include +#include +#include + +struct window { + vinci *g; + window *next; + xcb_window_t window; + xcb_pixmap_t pixmap; + xcb_gcontext_t gc; + uint16_t x; + uint16_t y; + uint16_t width; + uint16_t height; + void *bgra; + void *data; + window_cbs cbs; +}; + +struct vinci { + xcb_connection_t *connection; + xcb_screen_t *screen; + const xcb_setup_t *setup; + xcb_visualtype_t *visual; + xcb_atom_t wm_protocols_atom; + xcb_atom_t wm_delete_atom; + xcb_atom_t xembed_info_atom; + window *windows; + char keep_running; +}; + +vinci* vinci_new(void) { + vinci* g = (vinci*) malloc(sizeof(vinci)); + if (g == NULL) + return NULL; + + g->connection = xcb_connect(NULL, NULL); + if (xcb_connection_has_error(g->connection)) { + xcb_disconnect(g->connection); + return NULL; + } + g->screen = xcb_setup_roots_iterator(xcb_get_setup(g->connection)).data; + g->setup = xcb_get_setup(g->connection); + + xcb_visualtype_iterator_t visual_iter; xcb_intern_atom_reply_t* reply; // stupid C++ and its cross-initialization issues... + + xcb_depth_iterator_t depth_iter = xcb_screen_allowed_depths_iterator(g->screen); + xcb_depth_t *depth = NULL; + while (depth_iter.rem) { + if (depth_iter.data->depth == 24 && depth_iter.data->visuals_len) { + depth = depth_iter.data; + break; + } + xcb_depth_next(&depth_iter); + } + if (!depth) + goto err; + + visual_iter = xcb_depth_visuals_iterator(depth); + g->visual = NULL; + while (visual_iter.rem) { + if (visual_iter.data->_class == XCB_VISUAL_CLASS_TRUE_COLOR) { + g->visual = visual_iter.data; + break; + } + xcb_visualtype_next(&visual_iter); + } + if (!g->visual) + goto err; + + reply = xcb_intern_atom_reply(g->connection, xcb_intern_atom(g->connection, 1, 12, "WM_PROTOCOLS"), NULL); + if (!reply) + goto err; + g->wm_protocols_atom = reply->atom; + free(reply); + + reply = xcb_intern_atom_reply(g->connection, xcb_intern_atom(g->connection, 0, 16, "WM_DELETE_WINDOW"), NULL); + if (!reply) + goto err; + g->wm_delete_atom = reply->atom; + free(reply); + + reply = xcb_intern_atom_reply(g->connection, xcb_intern_atom(g->connection, 0, 12, "_XEMBED_INFO"), NULL); + if (!reply) + goto err; + g->xembed_info_atom = reply->atom; + free(reply); + + g->windows = NULL; + + return g; + +err: + free(g); + return NULL; +} + +void vinci_destroy(vinci* g) { + xcb_disconnect(g->connection); + free(g); +} + +static window* get_window(vinci* g, xcb_window_t xw) { + window* w = g->windows; + while (w->window != xw) + w = (window*)w->next; + return w; +} + +static uint32_t get_mouse_state(uint16_t state, xcb_button_t last) { + return ( + (state & XCB_BUTTON_MASK_1) >> 8 + | (state & XCB_BUTTON_MASK_2) >> 7 + | (state & XCB_BUTTON_MASK_3) >> 9 ) + ^ (last == 1 ? 1 : (last == 2 ? 4 : (last == 3 ? 2 : 0))) + ; +} + +void vinci_run(vinci* g, char single) { + g->keep_running = 1; + xcb_generic_event_t *ev; + struct pollfd pfd; + pfd.fd = xcb_get_file_descriptor(g->connection); + pfd.events = POLLIN; + while (g->keep_running) { + int err = poll(&pfd, 1, single ? 0 : -1); + if (err == -1) + break; + else if (err == 0 && single) + break; + + while (g->keep_running && (ev = xcb_poll_for_event(g->connection))) { + switch (ev->response_type & ~0x80) { + case XCB_EXPOSE: + { + xcb_expose_event_t *x = (xcb_expose_event_t *)ev; + window* w = get_window(g, x->window); + + xcb_copy_area(g->connection, w->pixmap, w->window, w->gc, x->x, x->y, x->x, x->y, x->width, x->height); + xcb_flush(g->connection); + } + break; + + case XCB_CONFIGURE_NOTIFY: + { + xcb_configure_notify_event_t *x = (xcb_configure_notify_event_t *)ev; + window* w = get_window(g, x->window); + + xcb_translate_coordinates_reply_t *trans = + xcb_translate_coordinates_reply(g->connection, xcb_translate_coordinates(g->connection, w->window, g->screen->root, 0, 0), NULL); + if (trans) { + if (trans->dst_x != w->x || trans->dst_y != w->y) { + w->x = trans->dst_x; + w->y = trans->dst_y; + if (w->cbs.on_window_move) + w->cbs.on_window_move(w, trans->dst_x, trans->dst_y); + } + free(trans); + } + + if (x->width != w->width || x->height != w->height) { + w->width = x->width; + w->height = x->height; + xcb_free_pixmap(g->connection, w->pixmap); + w->pixmap = xcb_generate_id(g->connection); + xcb_create_pixmap(g->connection, g->screen->root_depth, w->pixmap, w->window, x->width, x->height); + w->bgra = (uint8_t*) realloc(w->bgra, (w->width * w->height) << 2); + + if (w->cbs.on_window_resize) + w->cbs.on_window_resize(w, x->width, x->height); + } + } + break; + + case XCB_CLIENT_MESSAGE: + { + xcb_client_message_event_t *x = (xcb_client_message_event_t *)ev; + window* w = get_window(g, x->window); + if (w->cbs.on_window_close) { + if (x->data.data32[0] == g->wm_delete_atom) + w->cbs.on_window_close(w); + } + } + break; + + case XCB_BUTTON_PRESS: + { + xcb_button_press_event_t *x = (xcb_button_press_event_t *)ev; + window* w = get_window(g, x->event); + // First three buttons + if (w->cbs.on_mouse_press) { + if (x->detail <= 3) + w->cbs.on_mouse_press(w, x->event_x, x->event_y, get_mouse_state(x->state, x->detail)); + } + // wheel + if (w->cbs.on_mouse_wheel) { + if (x->detail == 4) + w->cbs.on_mouse_wheel(w, x->event_x, x->event_y, 57); + else if (x->detail == 5) + w->cbs.on_mouse_wheel(w, x->event_x, x->event_y, -57); + } + } + break; + + case XCB_BUTTON_RELEASE: + { + xcb_button_release_event_t *x = (xcb_button_release_event_t *)ev; + window* w = get_window(g, x->event); + + // First three buttons + if (x->detail <= 3) { + if (w->cbs.on_mouse_release) + w->cbs.on_mouse_release(w, x->event_x, x->event_y, get_mouse_state(x->state, x->detail)); + } + // Mouse wheel + else { + // Nothing to do + } + } + break; + + case XCB_MOTION_NOTIFY: + { + xcb_motion_notify_event_t *x = (xcb_motion_notify_event_t *)ev; + window* w = get_window(g, x->event); + if (w->cbs.on_mouse_move) + w->cbs.on_mouse_move(w, x->event_x, x->event_y, get_mouse_state(x->state, 0)); + } + break; + + case XCB_ENTER_NOTIFY: + { + xcb_enter_notify_event_t *x = (xcb_enter_notify_event_t *)ev; + window* w = get_window(g, x->event); + if (w->cbs.on_mouse_enter) + w->cbs.on_mouse_enter(w, x->event_x, x->event_y, get_mouse_state(x->state, 0)); + } + break; + + case XCB_LEAVE_NOTIFY: + { + xcb_leave_notify_event_t *x = (xcb_leave_notify_event_t *)ev; + window* w = get_window(g, x->event); + if (w->cbs.on_mouse_leave) + w->cbs.on_mouse_leave(w, x->event_x, x->event_y, get_mouse_state(x->state, 0)); + } + break; + + case XCB_KEY_PRESS: + { + xcb_key_press_event_t *x = (xcb_key_press_event_t *)ev; + window* w = get_window(g, x->event); + if (w->cbs.on_key_press) + w->cbs.on_key_press(w, x->detail, x->state); + } + break; + + case XCB_KEY_RELEASE: + { + xcb_key_release_event_t *x = (xcb_key_release_event_t *)ev; + window* w = get_window(g, x->event); + if (w->cbs.on_key_release) + w->cbs.on_key_release(w, x->detail, x->state); + } + break; + + default: + break; + } + free(ev); + } + } +} + +void vinci_stop(vinci* g) { + g->keep_running = 0; +} + +#define XEMBED_MAPPED (1 << 0) + +window* window_new(vinci* g, void* p, uint32_t width, uint32_t height, window_cbs *cbs) { + xcb_window_t *parent = (xcb_window_t *) p; + + window* ret = (window*) malloc(sizeof(window)); + if (ret == NULL) + return NULL; + ret->bgra = malloc((width * height) << 2); + if (!ret->bgra) { + free(ret); + return NULL; + } + + ret->window = xcb_generate_id(g->connection); + uint32_t mask = XCB_CW_EVENT_MASK; + uint32_t values[] = { XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_STRUCTURE_NOTIFY + | XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE + | XCB_EVENT_MASK_POINTER_MOTION | XCB_EVENT_MASK_BUTTON_MOTION + | XCB_EVENT_MASK_ENTER_WINDOW | XCB_EVENT_MASK_LEAVE_WINDOW + | XCB_EVENT_MASK_KEY_PRESS | XCB_EVENT_MASK_KEY_RELEASE }; + xcb_create_window(g->connection, 24, ret->window, parent ? *parent : g->screen->root, + 0, 0, width, height, 0, XCB_WINDOW_CLASS_INPUT_OUTPUT, + g->visual->visual_id, mask, values); + + ret->pixmap = xcb_generate_id(g->connection); + xcb_create_pixmap(g->connection, g->screen->root_depth, ret->pixmap, ret->window, width, height); + ret->gc = xcb_generate_id(g->connection); + xcb_create_gc(g->connection, ret->gc, ret->pixmap, 0, NULL); + + uint32_t xembed_info[] = { 0, 0 }; + xcb_change_property(g->connection, XCB_PROP_MODE_REPLACE, ret->window, g->xembed_info_atom, g->xembed_info_atom, 32, 2, xembed_info); + + // Subscribe to window close events + xcb_change_property(g->connection, XCB_PROP_MODE_REPLACE, ret->window, g->wm_protocols_atom, XCB_ATOM_ATOM, 32, 1, &(g->wm_delete_atom)); + + xcb_flush(g->connection); + + ret->next = NULL; + if (g->windows == NULL) + g->windows = ret; + else { + window* n = g->windows; + while (n->next) + n = (window*) n->next; + n->next = ret; + } + + ret->g = g; + ret->x = 0; + ret->y = 0; + ret->width = width; + ret->height = height; + ret->data = NULL; + ret->cbs = *cbs; + + return ret; +} + +void window_free(window* w) { + if (w->g->windows == w) + w->g->windows = w->next; + else { + window* n = w->g->windows; + while ((window*) n->next != w) + n = (window*) n->next; + n->next = w->next; + } + + xcb_free_gc(w->g->connection, w->gc); + xcb_free_pixmap(w->g->connection, w->pixmap); + xcb_destroy_window(w->g->connection, w->window); + xcb_flush(w->g->connection); + free(w->bgra); + free(w); +} + +void window_draw(window* w, unsigned char *data, int32_t dx, int32_t dy, int32_t dw, int32_t dh, int32_t wx, int32_t wy, int32_t width, int32_t height) { + + const int32_t wx_ = wx < 0 ? 0 : wx; + const int32_t wy_ = wy < 0 ? 0 : wy; + width = width - (wx_ - wx); + height = height - (wy_ - wy); + if (width <= 0 || height <= 0 ) + return; + dx = dx + (wx_ - wx); + dy = dy + (wy_ - wy); + wx = wx_; + wy = wy_; + + uint8_t *bgra = (uint8_t*) w->bgra; + + int32_t i = 0; + int32_t o = (dw * dy + dx) << 2; + int32_t p = (dw - width) << 2; + + if (w->g->setup->image_byte_order == XCB_IMAGE_ORDER_LSB_FIRST) { + for (int32_t y = dy; y < dy + height && y < dh; y++) { + for (int32_t x = dx; x < dx + width; x++, o += 4) { + bgra[i++] = data[o + 2]; + bgra[i++] = data[o + 1]; + bgra[i++] = data[o ]; + i++; + } + o += p; + } + } else { + for (int32_t y = dy; y < dy + height; y++) { + for (int32_t x = dx; x < dx + width; x++, o += 4) { + bgra[i++] = data[o ]; + bgra[i++] = data[o + 1]; + bgra[i++] = data[o + 2]; + i++; + } + o += p; + } + } + + const uint32_t bytes = (width * height) << 2; + xcb_put_image(w->g->connection, XCB_IMAGE_FORMAT_Z_PIXMAP, w->pixmap, w->gc, width, height, wx, wy, 0, w->g->screen->root_depth, bytes, bgra); + xcb_copy_area(w->g->connection, w->pixmap, w->window, w->gc, wx, wy, wx, wy, width, height); + xcb_flush(w->g->connection); +} + +void *window_get_handle(window* w) { + return &w->window; +} + +uint32_t window_get_width(window* w) { + return w->width; +} +uint32_t window_get_height(window* w) { + return w->height; +} +/* + // In case we need to get w and h from x: + xcb_get_geometry_cookie_t geom_cookie = xcb_get_geometry(w->g->connection, w->window); + xcb_get_geometry_reply_t *cr = xcb_get_geometry_reply(w->g->connection, geom_cookie, NULL); + cr->width; cr->height; +*/ + +void window_resize(window* w, uint32_t width, uint32_t height) { + const uint32_t values[] = { width, height }; + xcb_configure_window(w->g->connection, w->window, XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT, values); + xcb_clear_area(w->g->connection, 1, w->window, 0, 0, width, height); + xcb_flush(w->g->connection); +} + +void window_move (window* w, uint32_t x, uint32_t y) { + (void) x; + (void) y; + const uint32_t values[] = { w->width, w->height }; + xcb_configure_window(w->g->connection, w->window, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y, values); + xcb_flush(w->g->connection); +} + +void window_show(window* w) { + uint32_t xembed_info[] = { 0, XEMBED_MAPPED }; + xcb_change_property(w->g->connection, XCB_PROP_MODE_REPLACE, w->window, w->g->xembed_info_atom, w->g->xembed_info_atom, 32, 2, xembed_info); + xcb_map_window(w->g->connection, w->window); + xcb_flush(w->g->connection); +} + +void window_hide(window* w) { + uint32_t xembed_info[] = { 0, 0 }; + xcb_change_property(w->g->connection, XCB_PROP_MODE_REPLACE, w->window, w->g->xembed_info_atom, w->g->xembed_info_atom, 32, 2, xembed_info); + xcb_unmap_window(w->g->connection, w->window); + xcb_flush(w->g->connection); +} + +void window_set_data(window* w, void *data) { + w->data = data; +} + +void *window_get_data(window* w) { + return w->data; +} \ No newline at end of file diff --git a/vinci.h b/vinci.h new file mode 100644 index 0000000..f13072b --- /dev/null +++ b/vinci.h @@ -0,0 +1,62 @@ +/* + * Vinci + * + * Copyright (C) 2025 Orastron Srl unipersonale + * + * Vinci 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, version 3 of the License. + * + * Vinci 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 Vinci. If not, see . + * + * File author: Paolo Marrone + */ + + +#ifndef VINCI_H +#define VINCI_H + +#include + +typedef struct vinci vinci; +typedef struct window window; +typedef struct window_cbs { + void (*on_window_resize) (window *w, int32_t width, int32_t height); + void (*on_window_close) (window *w); + void (*on_window_move) (window *w, uint32_t x, uint32_t y); + + void (*on_mouse_move) (window *w, int32_t x, int32_t y, uint32_t state); + void (*on_mouse_press) (window *w, int32_t x, int32_t y, uint32_t state); + void (*on_mouse_release) (window *w, int32_t x, int32_t y, uint32_t state); + void (*on_mouse_wheel) (window *w, int32_t x, int32_t y, uint32_t state); + void (*on_mouse_enter) (window *w, int32_t x, int32_t y, uint32_t state); + void (*on_mouse_leave) (window *w, int32_t x, int32_t y, uint32_t state); + + void (*on_key_press) (window *w, uint32_t keycode, uint32_t state); + void (*on_key_release) (window *w, uint32_t keycode, uint32_t state); +} window_cbs; + +vinci* vinci_new (void); +void vinci_destroy (vinci *g); +void vinci_run (vinci *g, char single); +void vinci_stop (vinci *g); +window* window_new (vinci *g, void* p, uint32_t width, uint32_t height, window_cbs *cbs); +void window_free (window *w); +void window_draw (window *w, unsigned char *data, int32_t dx, int32_t dy, int32_t dw, int32_t dh, int32_t wx, int32_t wy, int32_t width, int32_t height); +void* window_get_handle(window *w); +uint32_t window_get_width (window *w); // Internal: excluding title etc +uint32_t window_get_height(window *w); // ^ +void window_resize (window *w, uint32_t width, uint32_t height); +void window_move (window *w, uint32_t x, uint32_t y); +void window_show (window *w); +void window_hide (window *w); +void window_set_data (window *w, void *data); +void* window_get_data (window *w); + +#endif \ No newline at end of file