diff options
| author | Sergey Bugaev <bugaevc@gmail.com> | 2021-11-08 18:58:17 +0300 |
|---|---|---|
| committer | Sergey Bugaev <bugaevc@gmail.com> | 2021-11-08 18:58:17 +0300 |
| commit | 0ad40986dceae8f40d722ac2e154800a9c630522 (patch) | |
| tree | 00682376e5f34f171f8bd0e1d4ddf23606efe138 | |
Initial commit
120 files changed, 14941 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1ea8c5a --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +.DS_Store + +build/ +DerivedData + +*.pbxuser +!default.pbxuser +*.mode1v3 +!default.mode1v3 + +xcuserdata @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..d327c0f --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Owl + +Owl is a portable [Wayland] compositor written in Objective-C, using Cocoa as +its backend. Owl primarily targets Mac OS X, but also supports a variety of +other operating systems thanks to [GNUstep]. + +[Wayland]: https://wayland.freedesktop.org/ +[GNUstep]: http://www.gnustep.org/ + +Owl makes it possible to run Wayland clients inside OS X's native Quartz +graphics environment. In that sense, Owl plays a role similar to the [XQuartz] +and [XWayland] compatibility layers. + +[XQuartz]: https://www.xquartz.org/ +[XWayland]: https://wayland.freedesktop.org/xserver.html + +# Work in progress + +Owl is a work in progress. Some things work, many don't. There's a lot to +improve and figure out! + +# Building + +First, make sure you have Wayland installed. Please see the other repositories +in [this GitHub organization] for ports of Wayland and related software to +systems that they don't normally support. + +[this GitHub organization]: https://github.com/owl-compositor + +To build Owl, create a build directory, then run `configure`, then `make`: + +``` +$ mkdir build +$ cd build +$ ../configure +Owl root directory detected as .. +$ make +``` + +If the build succeeds, you should find `Owl.app` in the build directory. + +# License + +Owl is free software, available under the GNU General Public License version 3 +or later. diff --git a/Resources/English.lproj/InfoPlist.strings b/Resources/English.lproj/InfoPlist.strings new file mode 100644 index 0000000..477b28f --- /dev/null +++ b/Resources/English.lproj/InfoPlist.strings @@ -0,0 +1,2 @@ +/* Localized versions of Info.plist keys */ + diff --git a/Resources/English.lproj/MainMenu.xib b/Resources/English.lproj/MainMenu.xib new file mode 100644 index 0000000..6f63f98 --- /dev/null +++ b/Resources/English.lproj/MainMenu.xib @@ -0,0 +1,1408 @@ +<?xml version="1.0" encoding="UTF-8"?> +<archive type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="7.10"> + <data> + <int key="IBDocument.SystemTarget">1060</int> + <string key="IBDocument.SystemVersion">10A432</string> + <string key="IBDocument.InterfaceBuilderVersion">732</string> + <string key="IBDocument.AppKitVersion">1038</string> + <string key="IBDocument.HIToolboxVersion">437.00</string> + <object class="NSMutableDictionary" key="IBDocument.PluginVersions"> + <string key="NS.key.0">com.apple.InterfaceBuilder.CocoaPlugin</string> + <string key="NS.object.0">732</string> + </object> + <object class="NSMutableArray" key="IBDocument.EditedObjectIDs"> + <bool key="EncodedWithXMLCoder">YES</bool> + <integer value="57"/> + </object> + <object class="NSArray" key="IBDocument.PluginDependencies"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + </object> + <object class="NSMutableDictionary" key="IBDocument.Metadata"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSArray" key="dict.sortedKeys" id="0"> + <bool key="EncodedWithXMLCoder">YES</bool> + </object> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + </object> + </object> + <object class="NSMutableArray" key="IBDocument.RootObjects" id="1048"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSCustomObject" id="1021"> + <string key="NSClassName">NSApplication</string> + </object> + <object class="NSCustomObject" id="1014"> + <string key="NSClassName">FirstResponder</string> + </object> + <object class="NSCustomObject" id="1050"> + <string key="NSClassName">NSApplication</string> + </object> + <object class="NSMenu" id="649796088"> + <string key="NSTitle">AMainMenu</string> + <object class="NSMutableArray" key="NSMenuItems"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSMenuItem" id="694149608"> + <reference key="NSMenu" ref="649796088"/> + <string key="NSTitle">Owl</string> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <object class="NSCustomResource" key="NSOnImage" id="35465992"> + <string key="NSClassName">NSImage</string> + <string key="NSResourceName">NSMenuCheckmark</string> + </object> + <object class="NSCustomResource" key="NSMixedImage" id="502551668"> + <string key="NSClassName">NSImage</string> + <string key="NSResourceName">NSMenuMixedState</string> + </object> + <string key="NSAction">submenuAction:</string> + <object class="NSMenu" key="NSSubmenu" id="110575045"> + <string key="NSTitle">Owl</string> + <object class="NSMutableArray" key="NSMenuItems"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSMenuItem" id="238522557"> + <reference key="NSMenu" ref="110575045"/> + <string key="NSTitle">About Owl</string> + <string key="NSKeyEquiv"/> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="304266470"> + <reference key="NSMenu" ref="110575045"/> + <bool key="NSIsDisabled">YES</bool> + <bool key="NSIsSeparator">YES</bool> + <string key="NSTitle"/> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="609285721"> + <reference key="NSMenu" ref="110575045"/> + <string key="NSTitle">Preferences…</string> + <string key="NSKeyEquiv">,</string> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="481834944"> + <reference key="NSMenu" ref="110575045"/> + <bool key="NSIsDisabled">YES</bool> + <bool key="NSIsSeparator">YES</bool> + <string key="NSTitle"/> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="1046388886"> + <reference key="NSMenu" ref="110575045"/> + <string key="NSTitle">Services</string> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + <string key="NSAction">submenuAction:</string> + <object class="NSMenu" key="NSSubmenu" id="752062318"> + <string key="NSTitle">Services</string> + <object class="NSMutableArray" key="NSMenuItems"> + <bool key="EncodedWithXMLCoder">YES</bool> + </object> + <string key="NSName">_NSServicesMenu</string> + </object> + </object> + <object class="NSMenuItem" id="646227648"> + <reference key="NSMenu" ref="110575045"/> + <bool key="NSIsDisabled">YES</bool> + <bool key="NSIsSeparator">YES</bool> + <string key="NSTitle"/> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="755159360"> + <reference key="NSMenu" ref="110575045"/> + <string key="NSTitle">Hide Owl</string> + <string key="NSKeyEquiv">h</string> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="342932134"> + <reference key="NSMenu" ref="110575045"/> + <string key="NSTitle">Hide Others</string> + <string key="NSKeyEquiv">h</string> + <int key="NSKeyEquivModMask">1572864</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="908899353"> + <reference key="NSMenu" ref="110575045"/> + <string key="NSTitle">Show All</string> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="1056857174"> + <reference key="NSMenu" ref="110575045"/> + <bool key="NSIsDisabled">YES</bool> + <bool key="NSIsSeparator">YES</bool> + <string key="NSTitle"/> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="632727374"> + <reference key="NSMenu" ref="110575045"/> + <string key="NSTitle">Quit Owl</string> + <string key="NSKeyEquiv">q</string> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + </object> + <string key="NSName">_NSAppleMenu</string> + </object> + </object> + <object class="NSMenuItem" id="235374797"> + <reference key="NSMenu" ref="649796088"/> + <string key="NSTitle">Clients</string> + <string key="NSKeyEquiv"/> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + <string key="NSAction">submenuAction:</string> + <object class="NSMenu" key="NSSubmenu" id="1020464353"> + <string key="NSTitle">Clients</string> + <object class="NSMutableArray" key="NSMenuItems"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSMenuItem" id="960730137"> + <reference key="NSMenu" ref="1020464353"/> + <string key="NSTitle">Item 1</string> + <string key="NSKeyEquiv"/> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="284758846"> + <reference key="NSMenu" ref="1020464353"/> + <string key="NSTitle">Item 2</string> + <string key="NSKeyEquiv"/> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="457126481"> + <reference key="NSMenu" ref="1020464353"/> + <string key="NSTitle">Item 3</string> + <string key="NSKeyEquiv"/> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + </object> + </object> + </object> + <object class="NSMenuItem" id="586577488"> + <reference key="NSMenu" ref="649796088"/> + <string key="NSTitle">View</string> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + <string key="NSAction">submenuAction:</string> + <object class="NSMenu" key="NSSubmenu" id="466310130"> + <string key="NSTitle">View</string> + <object class="NSMutableArray" key="NSMenuItems"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSMenuItem" id="102151532"> + <reference key="NSMenu" ref="466310130"/> + <string key="NSTitle">Show Toolbar</string> + <string key="NSKeyEquiv">t</string> + <int key="NSKeyEquivModMask">1572864</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="237841660"> + <reference key="NSMenu" ref="466310130"/> + <string key="NSTitle">Customize Toolbar…</string> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + </object> + </object> + </object> + <object class="NSMenuItem" id="713487014"> + <reference key="NSMenu" ref="649796088"/> + <string key="NSTitle">Window</string> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + <string key="NSAction">submenuAction:</string> + <object class="NSMenu" key="NSSubmenu" id="835318025"> + <string key="NSTitle">Window</string> + <object class="NSMutableArray" key="NSMenuItems"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSMenuItem" id="1011231497"> + <reference key="NSMenu" ref="835318025"/> + <string key="NSTitle">Minimize</string> + <string key="NSKeyEquiv">m</string> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="575023229"> + <reference key="NSMenu" ref="835318025"/> + <string key="NSTitle">Zoom</string> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="787363388"> + <reference key="NSMenu" ref="835318025"/> + <bool key="NSIsDisabled">YES</bool> + <bool key="NSIsSeparator">YES</bool> + <string key="NSTitle"/> + <string key="NSKeyEquiv"/> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="357838596"> + <reference key="NSMenu" ref="835318025"/> + <bool key="NSIsAlternate">YES</bool> + <string key="NSTitle">Server-Side Decorations</string> + <string key="NSKeyEquiv"/> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="299356726"> + <reference key="NSMenu" ref="835318025"/> + <bool key="NSIsDisabled">YES</bool> + <bool key="NSIsSeparator">YES</bool> + <string key="NSTitle"/> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + <object class="NSMenuItem" id="625202149"> + <reference key="NSMenu" ref="835318025"/> + <string key="NSTitle">Bring All to Front</string> + <string key="NSKeyEquiv"/> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + </object> + <string key="NSName">_NSWindowsMenu</string> + </object> + </object> + <object class="NSMenuItem" id="448692316"> + <reference key="NSMenu" ref="649796088"/> + <string key="NSTitle">Help</string> + <string key="NSKeyEquiv"/> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + <string key="NSAction">submenuAction:</string> + <object class="NSMenu" key="NSSubmenu" id="992780483"> + <string key="NSTitle">Help</string> + <object class="NSMutableArray" key="NSMenuItems"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSMenuItem" id="105068016"> + <reference key="NSMenu" ref="992780483"/> + <string key="NSTitle">Owl Help</string> + <string key="NSKeyEquiv">?</string> + <int key="NSKeyEquivModMask">1048576</int> + <int key="NSMnemonicLoc">2147483647</int> + <reference key="NSOnImage" ref="35465992"/> + <reference key="NSMixedImage" ref="502551668"/> + </object> + </object> + <string key="NSName">_NSHelpMenu</string> + </object> + </object> + </object> + <string key="NSName">_NSMainMenu</string> + </object> + <object class="NSCustomObject" id="976324537"> + <string key="NSClassName">OwlAppDelegate</string> + </object> + <object class="NSCustomObject" id="755631768"> + <string key="NSClassName">NSFontManager</string> + </object> + <object class="NSCustomObject" id="319288462"> + <string key="NSClassName">OwlKnownClientsManager</string> + </object> + <object class="NSCustomObject" id="1013310654"> + <string key="NSClassName">OwlPreferences</string> + </object> + </object> + <object class="IBObjectContainer" key="IBDocument.Objects"> + <object class="NSMutableArray" key="connectionRecords"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">performMiniaturize:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="1011231497"/> + </object> + <int key="connectionID">37</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">arrangeInFront:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="625202149"/> + </object> + <int key="connectionID">39</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">orderFrontStandardAboutPanel:</string> + <reference key="source" ref="1021"/> + <reference key="destination" ref="238522557"/> + </object> + <int key="connectionID">142</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">performZoom:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="575023229"/> + </object> + <int key="connectionID">240</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">runToolbarCustomizationPalette:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="237841660"/> + </object> + <int key="connectionID">365</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">toggleToolbarShown:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="102151532"/> + </object> + <int key="connectionID">366</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">hide:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="755159360"/> + </object> + <int key="connectionID">367</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">hideOtherApplications:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="342932134"/> + </object> + <int key="connectionID">368</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">unhideAllApplications:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="908899353"/> + </object> + <int key="connectionID">370</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">terminate:</string> + <reference key="source" ref="1050"/> + <reference key="destination" ref="632727374"/> + </object> + <int key="connectionID">449</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">showHelp:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="105068016"/> + </object> + <int key="connectionID">493</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBOutletConnection" key="connection"> + <string key="label">delegate</string> + <reference key="source" ref="1021"/> + <reference key="destination" ref="976324537"/> + </object> + <int key="connectionID">495</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">toggleDisplaySSD:</string> + <reference key="source" ref="1014"/> + <reference key="destination" ref="357838596"/> + </object> + <int key="connectionID">535</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBOutletConnection" key="connection"> + <string key="label">clientsMenu</string> + <reference key="source" ref="319288462"/> + <reference key="destination" ref="1020464353"/> + </object> + <int key="connectionID">565</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">openPreferencesWindow:</string> + <reference key="source" ref="1013310654"/> + <reference key="destination" ref="609285721"/> + </object> + <int key="connectionID">567</int> + </object> + </object> + <object class="IBMutableOrderedSet" key="objectRecords"> + <object class="NSArray" key="orderedObjects"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="IBObjectRecord"> + <int key="objectID">0</int> + <reference key="object" ref="0"/> + <reference key="children" ref="1048"/> + <nil key="parent"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">-2</int> + <reference key="object" ref="1021"/> + <reference key="parent" ref="0"/> + <string key="objectName">File's Owner</string> + </object> + <object class="IBObjectRecord"> + <int key="objectID">-1</int> + <reference key="object" ref="1014"/> + <reference key="parent" ref="0"/> + <string key="objectName">First Responder</string> + </object> + <object class="IBObjectRecord"> + <int key="objectID">-3</int> + <reference key="object" ref="1050"/> + <reference key="parent" ref="0"/> + <string key="objectName">Application</string> + </object> + <object class="IBObjectRecord"> + <int key="objectID">29</int> + <reference key="object" ref="649796088"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="713487014"/> + <reference ref="694149608"/> + <reference ref="586577488"/> + <reference ref="448692316"/> + <reference ref="235374797"/> + </object> + <reference key="parent" ref="0"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">19</int> + <reference key="object" ref="713487014"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="835318025"/> + </object> + <reference key="parent" ref="649796088"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">56</int> + <reference key="object" ref="694149608"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="110575045"/> + </object> + <reference key="parent" ref="649796088"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">57</int> + <reference key="object" ref="110575045"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="238522557"/> + <reference ref="755159360"/> + <reference ref="908899353"/> + <reference ref="632727374"/> + <reference ref="646227648"/> + <reference ref="609285721"/> + <reference ref="481834944"/> + <reference ref="304266470"/> + <reference ref="1046388886"/> + <reference ref="1056857174"/> + <reference ref="342932134"/> + </object> + <reference key="parent" ref="694149608"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">58</int> + <reference key="object" ref="238522557"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">134</int> + <reference key="object" ref="755159360"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">150</int> + <reference key="object" ref="908899353"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">136</int> + <reference key="object" ref="632727374"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">144</int> + <reference key="object" ref="646227648"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">129</int> + <reference key="object" ref="609285721"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">143</int> + <reference key="object" ref="481834944"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">236</int> + <reference key="object" ref="304266470"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">131</int> + <reference key="object" ref="1046388886"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="752062318"/> + </object> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">149</int> + <reference key="object" ref="1056857174"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">145</int> + <reference key="object" ref="342932134"/> + <reference key="parent" ref="110575045"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">130</int> + <reference key="object" ref="752062318"/> + <reference key="parent" ref="1046388886"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">24</int> + <reference key="object" ref="835318025"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="299356726"/> + <reference ref="625202149"/> + <reference ref="575023229"/> + <reference ref="1011231497"/> + <reference ref="787363388"/> + <reference ref="357838596"/> + </object> + <reference key="parent" ref="713487014"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">92</int> + <reference key="object" ref="299356726"/> + <reference key="parent" ref="835318025"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">5</int> + <reference key="object" ref="625202149"/> + <reference key="parent" ref="835318025"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">239</int> + <reference key="object" ref="575023229"/> + <reference key="parent" ref="835318025"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">23</int> + <reference key="object" ref="1011231497"/> + <reference key="parent" ref="835318025"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">295</int> + <reference key="object" ref="586577488"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="466310130"/> + </object> + <reference key="parent" ref="649796088"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">296</int> + <reference key="object" ref="466310130"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="102151532"/> + <reference ref="237841660"/> + </object> + <reference key="parent" ref="586577488"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">297</int> + <reference key="object" ref="102151532"/> + <reference key="parent" ref="466310130"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">298</int> + <reference key="object" ref="237841660"/> + <reference key="parent" ref="466310130"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">420</int> + <reference key="object" ref="755631768"/> + <reference key="parent" ref="0"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">490</int> + <reference key="object" ref="448692316"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="992780483"/> + </object> + <reference key="parent" ref="649796088"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">491</int> + <reference key="object" ref="992780483"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="105068016"/> + </object> + <reference key="parent" ref="448692316"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">492</int> + <reference key="object" ref="105068016"/> + <reference key="parent" ref="992780483"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">494</int> + <reference key="object" ref="976324537"/> + <reference key="parent" ref="0"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">533</int> + <reference key="object" ref="787363388"/> + <reference key="parent" ref="835318025"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">534</int> + <reference key="object" ref="357838596"/> + <reference key="parent" ref="835318025"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">550</int> + <reference key="object" ref="319288462"/> + <reference key="parent" ref="0"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">560</int> + <reference key="object" ref="235374797"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="1020464353"/> + </object> + <reference key="parent" ref="649796088"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">561</int> + <reference key="object" ref="1020464353"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="960730137"/> + <reference ref="284758846"/> + <reference ref="457126481"/> + </object> + <reference key="parent" ref="235374797"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">562</int> + <reference key="object" ref="960730137"/> + <reference key="parent" ref="1020464353"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">563</int> + <reference key="object" ref="284758846"/> + <reference key="parent" ref="1020464353"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">564</int> + <reference key="object" ref="457126481"/> + <reference key="parent" ref="1020464353"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">566</int> + <reference key="object" ref="1013310654"/> + <reference key="parent" ref="0"/> + </object> + </object> + </object> + <object class="NSMutableDictionary" key="flattenedProperties"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSArray" key="dict.sortedKeys"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>-3.IBPluginDependency</string> + <string>129.IBPluginDependency</string> + <string>129.ImportedFromIB2</string> + <string>130.IBEditorWindowLastContentRect</string> + <string>130.IBPluginDependency</string> + <string>130.ImportedFromIB2</string> + <string>130.editorWindowContentRectSynchronizationRect</string> + <string>131.IBPluginDependency</string> + <string>131.ImportedFromIB2</string> + <string>134.IBPluginDependency</string> + <string>134.ImportedFromIB2</string> + <string>136.IBPluginDependency</string> + <string>136.ImportedFromIB2</string> + <string>143.IBPluginDependency</string> + <string>143.ImportedFromIB2</string> + <string>144.IBPluginDependency</string> + <string>144.ImportedFromIB2</string> + <string>145.IBPluginDependency</string> + <string>145.ImportedFromIB2</string> + <string>149.IBPluginDependency</string> + <string>149.ImportedFromIB2</string> + <string>150.IBPluginDependency</string> + <string>150.ImportedFromIB2</string> + <string>19.IBPluginDependency</string> + <string>19.ImportedFromIB2</string> + <string>23.IBPluginDependency</string> + <string>23.ImportedFromIB2</string> + <string>236.IBPluginDependency</string> + <string>236.ImportedFromIB2</string> + <string>239.IBPluginDependency</string> + <string>239.ImportedFromIB2</string> + <string>24.IBEditorWindowLastContentRect</string> + <string>24.IBPluginDependency</string> + <string>24.ImportedFromIB2</string> + <string>24.editorWindowContentRectSynchronizationRect</string> + <string>29.IBEditorWindowLastContentRect</string> + <string>29.IBPluginDependency</string> + <string>29.ImportedFromIB2</string> + <string>29.WindowOrigin</string> + <string>29.editorWindowContentRectSynchronizationRect</string> + <string>295.IBPluginDependency</string> + <string>296.IBEditorWindowLastContentRect</string> + <string>296.IBPluginDependency</string> + <string>296.editorWindowContentRectSynchronizationRect</string> + <string>297.IBPluginDependency</string> + <string>298.IBPluginDependency</string> + <string>490.IBPluginDependency</string> + <string>491.IBEditorWindowLastContentRect</string> + <string>491.IBPluginDependency</string> + <string>492.IBPluginDependency</string> + <string>5.IBPluginDependency</string> + <string>5.ImportedFromIB2</string> + <string>533.IBPluginDependency</string> + <string>534.IBPluginDependency</string> + <string>550.IBPluginDependency</string> + <string>56.IBPluginDependency</string> + <string>56.ImportedFromIB2</string> + <string>560.IBPluginDependency</string> + <string>561.IBEditorWindowLastContentRect</string> + <string>561.IBPluginDependency</string> + <string>562.IBPluginDependency</string> + <string>563.IBPluginDependency</string> + <string>564.IBPluginDependency</string> + <string>566.IBPluginDependency</string> + <string>57.IBEditorWindowLastContentRect</string> + <string>57.IBPluginDependency</string> + <string>57.ImportedFromIB2</string> + <string>57.editorWindowContentRectSynchronizationRect</string> + <string>58.IBPluginDependency</string> + <string>58.ImportedFromIB2</string> + <string>92.IBPluginDependency</string> + <string>92.ImportedFromIB2</string> + </object> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>{{629, 776}, {64, 6}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>{{436, 809}, {64, 6}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>{{587, 739}, {242, 103}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>{{525, 802}, {197, 73}}</string> + <string>{{434, 842}, {306, 20}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>{74, 862}</string> + <string>{{6, 978}, {478, 20}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>{{542, 799}, {231, 43}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>{{475, 832}, {234, 43}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>{{724, 819}, {132, 23}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>{{493, 779}, {96, 63}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>{{446, 659}, {183, 183}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>{{23, 794}, {245, 183}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <integer value="1"/> + </object> + </object> + <object class="NSMutableDictionary" key="unlocalizedProperties"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference key="dict.sortedKeys" ref="0"/> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + </object> + </object> + <nil key="activeLocalization"/> + <object class="NSMutableDictionary" key="localizations"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference key="dict.sortedKeys" ref="0"/> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + </object> + </object> + <nil key="sourceID"/> + <int key="maxID">567</int> + </object> + <object class="IBClassDescriber" key="IBDocument.Classes"> + <object class="NSMutableArray" key="referencedPartialClassDescriptions"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="IBPartialClassDescription"> + <string key="className">OwlAppDelegate</string> + <string key="superclassName">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBProjectSource</string> + <string key="minorKey">OwlAppDelegate.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">OwlKnownClientsManager</string> + <string key="superclassName">NSObject</string> + <object class="NSMutableDictionary" key="actions"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSArray" key="dict.sortedKeys"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>configureClients:</string> + <string>startClient:</string> + </object> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>id</string> + <string>id</string> + </object> + </object> + <object class="NSMutableDictionary" key="outlets"> + <string key="NS.key.0">clientsMenu</string> + <string key="NS.object.0">NSMenu</string> + </object> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBProjectSource</string> + <string key="minorKey">OwlKnownClientsManager.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">OwlPreferences</string> + <string key="superclassName">NSObject</string> + <object class="NSMutableDictionary" key="actions"> + <string key="NS.key.0">openPreferencesWindow:</string> + <string key="NS.object.0">id</string> + </object> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBProjectSource</string> + <string key="minorKey">OwlPreferences.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">OwlWindow</string> + <string key="superclassName">NSWindow</string> + <object class="NSMutableDictionary" key="actions"> + <string key="NS.key.0">toggleDisplaySSD:</string> + <string key="NS.object.0">NSMenuItem</string> + </object> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBProjectSource</string> + <string key="minorKey">OwlWindow.h</string> + </object> + </object> + </object> + <object class="NSMutableArray" key="referencedPartialClassDescriptionsV3.2+"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <string key="superclassName">NSResponder</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="822405504"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSApplication.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="850738725"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSApplicationScripting.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="624831158"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSColorPanel.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSHelpManager.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSPageLayout.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSUserInterfaceItemSearching.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSFontManager</string> + <string key="superclassName">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="946436764"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSFontManager.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSMenu</string> + <string key="superclassName">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="1056362899"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSMenu.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSMenuItem</string> + <string key="superclassName">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="472958451"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSMenuItem.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSAccessibility.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="822405504"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="850738725"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="624831158"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSControl.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSDictionaryController.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSDragging.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="946436764"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSFontPanel.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSKeyValueBinding.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="1056362899"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSNibLoading.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSOutlineView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSPasteboard.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSSavePanel.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSTableView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSToolbarItem.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="260078765"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSArchiver.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSClassDescription.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSError.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSFileManager.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSKeyValueCoding.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSKeyValueObserving.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSKeyedArchiver.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSObject.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSObjectScripting.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSPortCoder.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSRunLoop.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSScriptClassDescription.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSScriptKeyValueCoding.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSScriptObjectSpecifiers.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSScriptWhoseTests.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSThread.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSURL.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSURLConnection.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSURLDownload.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSResponder</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSInterfaceStyle.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSResponder</string> + <string key="superclassName">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSResponder.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSView</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSClipView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSView</string> + <reference key="sourceIdentifier" ref="472958451"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSView</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSRulerView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSView</string> + <string key="superclassName">NSResponder</string> + <reference key="sourceIdentifier" ref="260078765"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSWindow</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSDrawer.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSWindow</string> + <string key="superclassName">NSResponder</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSWindow.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSWindow</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSWindowScripting.h</string> + </object> + </object> + </object> + </object> + <int key="IBDocument.localizationMode">0</int> + <object class="NSMutableDictionary" key="IBDocument.PluginDeclaredDependencyDefaults"> + <string key="NS.key.0">com.apple.InterfaceBuilder.CocoaPlugin.macosx</string> + <integer value="1060" key="NS.object.0"/> + </object> + <object class="NSMutableDictionary" key="IBDocument.PluginDeclaredDevelopmentDependencies"> + <string key="NS.key.0">com.apple.InterfaceBuilder.CocoaPlugin.InterfaceBuilder3</string> + <integer value="3000" key="NS.object.0"/> + </object> + <bool key="IBDocument.PluginDeclaredDependenciesTrackSystemTargetVersion">YES</bool> + <string key="IBDocument.LastKnownRelativeProjectPath">../Owl.xcodeproj</string> + <int key="IBDocument.defaultPropertyAccessControl">3</int> + </data> +</archive> diff --git a/Resources/English.lproj/OwlPreferences.xib b/Resources/English.lproj/OwlPreferences.xib new file mode 100644 index 0000000..e5aa8f6 --- /dev/null +++ b/Resources/English.lproj/OwlPreferences.xib @@ -0,0 +1,672 @@ +<?xml version="1.0" encoding="UTF-8"?> +<archive type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="7.10"> + <data> + <int key="IBDocument.SystemTarget">1060</int> + <string key="IBDocument.SystemVersion">10A432</string> + <string key="IBDocument.InterfaceBuilderVersion">732</string> + <string key="IBDocument.AppKitVersion">1038</string> + <string key="IBDocument.HIToolboxVersion">437.00</string> + <object class="NSMutableDictionary" key="IBDocument.PluginVersions"> + <string key="NS.key.0">com.apple.InterfaceBuilder.CocoaPlugin</string> + <string key="NS.object.0">732</string> + </object> + <object class="NSMutableArray" key="IBDocument.EditedObjectIDs"> + <bool key="EncodedWithXMLCoder">YES</bool> + <integer value="2"/> + </object> + <object class="NSArray" key="IBDocument.PluginDependencies"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + </object> + <object class="NSMutableDictionary" key="IBDocument.Metadata"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSArray" key="dict.sortedKeys" id="0"> + <bool key="EncodedWithXMLCoder">YES</bool> + </object> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + </object> + </object> + <object class="NSMutableArray" key="IBDocument.RootObjects" id="1000"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSCustomObject" id="1001"> + <string key="NSClassName">OwlPreferences</string> + </object> + <object class="NSCustomObject" id="1003"> + <string key="NSClassName">FirstResponder</string> + </object> + <object class="NSCustomObject" id="1004"> + <string key="NSClassName">NSApplication</string> + </object> + <object class="NSWindowTemplate" id="1005"> + <int key="NSWindowStyleMask">15</int> + <int key="NSWindowBacking">2</int> + <string key="NSWindowRect">{{196, 240}, {480, 270}}</string> + <int key="NSWTFlags">544735232</int> + <string key="NSWindowTitle">Owl Preferences</string> + <string key="NSWindowClass">NSWindow</string> + <nil key="NSViewClass"/> + <string key="NSWindowContentMaxSize">{1.79769e+308, 1.79769e+308}</string> + <object class="NSView" key="NSWindowView" id="1006"> + <reference key="NSNextResponder"/> + <int key="NSvFlags">256</int> + <object class="NSMutableArray" key="NSSubviews"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSButton" id="613206411"> + <reference key="NSNextResponder" ref="1006"/> + <int key="NSvFlags">268</int> + <string key="NSFrame">{{18, 234}, {444, 18}}</string> + <reference key="NSSuperview" ref="1006"/> + <bool key="NSEnabled">YES</bool> + <object class="NSButtonCell" key="NSCell" id="457795914"> + <int key="NSCellFlags">-2080244224</int> + <int key="NSCellFlags2">0</int> + <string key="NSContents">Prefer server-side decorations for clients that support it</string> + <object class="NSFont" key="NSSupport"> + <string key="NSName">LucidaGrande</string> + <double key="NSSize">13</double> + <int key="NSfFlags">1044</int> + </object> + <reference key="NSControlView" ref="613206411"/> + <int key="NSButtonFlags">1211912703</int> + <int key="NSButtonFlags2">2</int> + <object class="NSCustomResource" key="NSNormalImage"> + <string key="NSClassName">NSImage</string> + <string key="NSResourceName">NSSwitch</string> + </object> + <object class="NSButtonImageSource" key="NSAlternateImage"> + <string key="NSImageName">NSSwitch</string> + </object> + <string key="NSAlternateContents"/> + <string key="NSKeyEquivalent"/> + <int key="NSPeriodicDelay">200</int> + <int key="NSPeriodicInterval">25</int> + </object> + </object> + </object> + <string key="NSFrameSize">{480, 270}</string> + <reference key="NSSuperview"/> + </object> + <string key="NSScreenRect">{{0, 0}, {1680, 1028}}</string> + <string key="NSMaxSize">{1.79769e+308, 1.79769e+308}</string> + </object> + </object> + <object class="IBObjectContainer" key="IBDocument.Objects"> + <object class="NSMutableArray" key="connectionRecords"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="IBConnectionRecord"> + <object class="IBOutletConnection" key="connection"> + <string key="label">preferSSDButton</string> + <reference key="source" ref="1001"/> + <reference key="destination" ref="613206411"/> + </object> + <int key="connectionID">5</int> + </object> + <object class="IBConnectionRecord"> + <object class="IBActionConnection" key="connection"> + <string key="label">takePreferSSD:</string> + <reference key="source" ref="1001"/> + <reference key="destination" ref="613206411"/> + </object> + <int key="connectionID">6</int> + </object> + </object> + <object class="IBMutableOrderedSet" key="objectRecords"> + <object class="NSArray" key="orderedObjects"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="IBObjectRecord"> + <int key="objectID">0</int> + <reference key="object" ref="0"/> + <reference key="children" ref="1000"/> + <nil key="parent"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">-2</int> + <reference key="object" ref="1001"/> + <reference key="parent" ref="0"/> + <string key="objectName">File's Owner</string> + </object> + <object class="IBObjectRecord"> + <int key="objectID">-1</int> + <reference key="object" ref="1003"/> + <reference key="parent" ref="0"/> + <string key="objectName">First Responder</string> + </object> + <object class="IBObjectRecord"> + <int key="objectID">-3</int> + <reference key="object" ref="1004"/> + <reference key="parent" ref="0"/> + <string key="objectName">Application</string> + </object> + <object class="IBObjectRecord"> + <int key="objectID">1</int> + <reference key="object" ref="1005"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="1006"/> + </object> + <reference key="parent" ref="0"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">2</int> + <reference key="object" ref="1006"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="613206411"/> + </object> + <reference key="parent" ref="1005"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">3</int> + <reference key="object" ref="613206411"/> + <object class="NSMutableArray" key="children"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference ref="457795914"/> + </object> + <reference key="parent" ref="1006"/> + </object> + <object class="IBObjectRecord"> + <int key="objectID">4</int> + <reference key="object" ref="457795914"/> + <reference key="parent" ref="613206411"/> + </object> + </object> + </object> + <object class="NSMutableDictionary" key="flattenedProperties"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSArray" key="dict.sortedKeys"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>1.IBEditorWindowLastContentRect</string> + <string>1.IBPluginDependency</string> + <string>1.IBWindowTemplateEditedContentRect</string> + <string>1.NSWindowTemplate.visibleAtLaunch</string> + <string>1.WindowOrigin</string> + <string>1.editorWindowContentRectSynchronizationRect</string> + <string>2.IBPluginDependency</string> + <string>3.IBPluginDependency</string> + <string>4.IBPluginDependency</string> + </object> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>{{927, 393}, {480, 270}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>{{927, 393}, {480, 270}}</string> + <integer value="1"/> + <string>{196, 240}</string> + <string>{{202, 428}, {480, 270}}</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + <string>com.apple.InterfaceBuilder.CocoaPlugin</string> + </object> + </object> + <object class="NSMutableDictionary" key="unlocalizedProperties"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference key="dict.sortedKeys" ref="0"/> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + </object> + </object> + <nil key="activeLocalization"/> + <object class="NSMutableDictionary" key="localizations"> + <bool key="EncodedWithXMLCoder">YES</bool> + <reference key="dict.sortedKeys" ref="0"/> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + </object> + </object> + <nil key="sourceID"/> + <int key="maxID">6</int> + </object> + <object class="IBClassDescriber" key="IBDocument.Classes"> + <object class="NSMutableArray" key="referencedPartialClassDescriptions"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="IBPartialClassDescription"> + <string key="className">OwlPreferences</string> + <string key="superclassName">NSObject</string> + <object class="NSMutableDictionary" key="actions"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="NSArray" key="dict.sortedKeys"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>openPreferencesWindow:</string> + <string>takePreferSSD:</string> + </object> + <object class="NSMutableArray" key="dict.values"> + <bool key="EncodedWithXMLCoder">YES</bool> + <string>id</string> + <string>id</string> + </object> + </object> + <object class="NSMutableDictionary" key="outlets"> + <string key="NS.key.0">preferSSDButton</string> + <string key="NS.object.0">NSButton</string> + </object> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBProjectSource</string> + <string key="minorKey">OwlPreferences.h</string> + </object> + </object> + </object> + <object class="NSMutableArray" key="referencedPartialClassDescriptionsV3.2+"> + <bool key="EncodedWithXMLCoder">YES</bool> + <object class="IBPartialClassDescription"> + <string key="className">NSActionCell</string> + <string key="superclassName">NSCell</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSActionCell.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <string key="superclassName">NSResponder</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="883701835"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSApplication.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="925177979"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSApplicationScripting.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="492519761"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSColorPanel.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSHelpManager.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSPageLayout.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSApplication</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSUserInterfaceItemSearching.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSButton</string> + <string key="superclassName">NSControl</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSButton.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSButtonCell</string> + <string key="superclassName">NSActionCell</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSButtonCell.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSCell</string> + <string key="superclassName">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSCell.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSControl</string> + <string key="superclassName">NSView</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="529079333"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSControl.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSFormatter</string> + <string key="superclassName">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSFormatter.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSMenu</string> + <string key="superclassName">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="101786176"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSMenu.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSAccessibility.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="883701835"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="925177979"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="492519761"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="529079333"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSDictionaryController.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSDragging.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSFontManager.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSFontPanel.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSKeyValueBinding.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <reference key="sourceIdentifier" ref="101786176"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSNibLoading.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSOutlineView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSPasteboard.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSSavePanel.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSTableView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSToolbarItem.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier" id="733769177"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSArchiver.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSClassDescription.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSError.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSFileManager.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSKeyValueCoding.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSKeyValueObserving.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSKeyedArchiver.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSObject.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSObjectScripting.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSPortCoder.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSRunLoop.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSScriptClassDescription.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSScriptKeyValueCoding.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSScriptObjectSpecifiers.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSScriptWhoseTests.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSThread.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSURL.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSURLConnection.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">Foundation.framework/Headers/NSURLDownload.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSResponder</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSInterfaceStyle.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSResponder</string> + <string key="superclassName">NSObject</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSResponder.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSView</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSClipView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSView</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSMenuItem.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSView</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSRulerView.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSView</string> + <string key="superclassName">NSResponder</string> + <reference key="sourceIdentifier" ref="733769177"/> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSWindow</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSDrawer.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSWindow</string> + <string key="superclassName">NSResponder</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSWindow.h</string> + </object> + </object> + <object class="IBPartialClassDescription"> + <string key="className">NSWindow</string> + <object class="IBClassDescriptionSource" key="sourceIdentifier"> + <string key="majorKey">IBFrameworkSource</string> + <string key="minorKey">AppKit.framework/Headers/NSWindowScripting.h</string> + </object> + </object> + </object> + </object> + <int key="IBDocument.localizationMode">0</int> + <object class="NSMutableDictionary" key="IBDocument.PluginDeclaredDependencyDefaults"> + <string key="NS.key.0">com.apple.InterfaceBuilder.CocoaPlugin.macosx</string> + <integer value="1060" key="NS.object.0"/> + </object> + <object class="NSMutableDictionary" key="IBDocument.PluginDeclaredDevelopmentDependencies"> + <string key="NS.key.0">com.apple.InterfaceBuilder.CocoaPlugin.InterfaceBuilder3</string> + <integer value="3000" key="NS.object.0"/> + </object> + <bool key="IBDocument.PluginDeclaredDependenciesTrackSystemTargetVersion">YES</bool> + <string key="IBDocument.LastKnownRelativeProjectPath">Owl.xcodeproj</string> + <int key="IBDocument.defaultPropertyAccessControl">3</int> + </data> +</archive> diff --git a/Resources/Owl-Info-gnustep.plist b/Resources/Owl-Info-gnustep.plist new file mode 100644 index 0000000..bfa24b3 --- /dev/null +++ b/Resources/Owl-Info-gnustep.plist @@ -0,0 +1,9 @@ +{ + ApplicationDescription = "Owl, a Wayland compositor in Objective-C"; + ApplicationName = Owl; + ApplicationRelease = "Owl 0.9"; + NSExecutable = Owl; + NSIcon = "Owl.icns"; + NSMainNibFile = "MainMenu"; + NSPrincipalClass = NSApplication; +} diff --git a/Resources/Owl-Info.plist b/Resources/Owl-Info.plist new file mode 100644 index 0000000..c2e7f4a --- /dev/null +++ b/Resources/Owl-Info.plist @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<plist version="1.0"> +<dict> + <key>CFBundleDevelopmentRegion</key> + <string>English</string> + <key>CFBundleExecutable</key> + <string>Owl</string> + <key>CFBundleIconFile</key> + <string>Owl</string> + <key>CFBundleIdentifier</key> + <string>io.github.bugaevc.Owl</string> + <key>CFBundleInfoDictionaryVersion</key> + <string>6.0</string> + <key>CFBundleName</key> + <string>Owl</string> + <key>CFBundlePackageType</key> + <string>APPL</string> + <key>CFBundleSignature</key> + <string>????</string> + <key>CFBundleShortVersionString</key> + <string>1.0</string> + <key>CFBundleVersion</key> + <string>1</string> + <key>NSMainNibFile</key> + <string>MainMenu</string> + <key>NSPrincipalClass</key> + <string>NSApplication</string> +</dict> +</plist> diff --git a/Resources/Owl.icns b/Resources/Owl.icns Binary files differnew file mode 100644 index 0000000..58be248 --- /dev/null +++ b/Resources/Owl.icns diff --git a/Resources/keymap.xkb b/Resources/keymap.xkb new file mode 100644 index 0000000..95d3934 --- /dev/null +++ b/Resources/keymap.xkb @@ -0,0 +1,1464 @@ +xkb_keymap { +xkb_keycodes "(unnamed)" { + minimum = 8; + maximum = 374; + <ESC> = 9; + <AE01> = 10; + <AE02> = 11; + <AE03> = 12; + <AE04> = 13; + <AE05> = 14; + <AE06> = 15; + <AE07> = 16; + <AE08> = 17; + <AE09> = 18; + <AE10> = 19; + <AE11> = 20; + <AE12> = 21; + <BKSP> = 22; + <TAB> = 23; + <AD01> = 24; + <AD02> = 25; + <AD03> = 26; + <AD04> = 27; + <AD05> = 28; + <AD06> = 29; + <AD07> = 30; + <AD08> = 31; + <AD09> = 32; + <AD10> = 33; + <AD11> = 34; + <AD12> = 35; + <RTRN> = 36; + <LCTL> = 37; + <AC01> = 38; + <AC02> = 39; + <AC03> = 40; + <AC04> = 41; + <AC05> = 42; + <AC06> = 43; + <AC07> = 44; + <AC08> = 45; + <AC09> = 46; + <AC10> = 47; + <AC11> = 48; + <TLDE> = 49; + <LFSH> = 50; + <BKSL> = 51; + <AB01> = 52; + <AB02> = 53; + <AB03> = 54; + <AB04> = 55; + <AB05> = 56; + <AB06> = 57; + <AB07> = 58; + <AB08> = 59; + <AB09> = 60; + <AB10> = 61; + <RTSH> = 62; + <KPMU> = 63; + <LALT> = 64; + <SPCE> = 65; + <CAPS> = 66; + <FK01> = 67; + <FK02> = 68; + <FK03> = 69; + <FK04> = 70; + <FK05> = 71; + <FK06> = 72; + <FK07> = 73; + <FK08> = 74; + <FK09> = 75; + <FK10> = 76; + <NMLK> = 77; + <SCLK> = 78; + <KP7> = 79; + <KP8> = 80; + <KP9> = 81; + <KPSU> = 82; + <KP4> = 83; + <KP5> = 84; + <KP6> = 85; + <KPAD> = 86; + <KP1> = 87; + <KP2> = 88; + <KP3> = 89; + <KP0> = 90; + <KPDL> = 91; + <LVL3> = 92; + <LSGT> = 94; + <FK11> = 95; + <FK12> = 96; + <AB11> = 97; + <KATA> = 98; + <HIRA> = 99; + <HENK> = 100; + <HKTG> = 101; + <MUHE> = 102; + <JPCM> = 103; + <KPEN> = 104; + <RCTL> = 105; + <KPDV> = 106; + <PRSC> = 107; + <RALT> = 108; + <LNFD> = 109; + <HOME> = 110; + <UP> = 111; + <PGUP> = 112; + <LEFT> = 113; + <RGHT> = 114; + <END> = 115; + <DOWN> = 116; + <PGDN> = 117; + <INS> = 118; + <DELE> = 119; + <I120> = 120; + <MUTE> = 121; + <VOL-> = 122; + <VOL+> = 123; + <POWR> = 124; + <KPEQ> = 125; + <I126> = 126; + <PAUS> = 127; + <I128> = 128; + <I129> = 129; + <HNGL> = 130; + <HJCV> = 131; + <AE13> = 132; + <LWIN> = 133; + <RWIN> = 134; + <COMP> = 135; + <STOP> = 136; + <AGAI> = 137; + <PROP> = 138; + <UNDO> = 139; + <FRNT> = 140; + <COPY> = 141; + <OPEN> = 142; + <PAST> = 143; + <FIND> = 144; + <CUT> = 145; + <HELP> = 146; + <I147> = 147; + <I148> = 148; + <I149> = 149; + <I150> = 150; + <I151> = 151; + <I152> = 152; + <I153> = 153; + <I154> = 154; + <I155> = 155; + <I156> = 156; + <I157> = 157; + <I158> = 158; + <I159> = 159; + <I160> = 160; + <I161> = 161; + <I162> = 162; + <I163> = 163; + <I164> = 164; + <I165> = 165; + <I166> = 166; + <I167> = 167; + <I168> = 168; + <I169> = 169; + <I170> = 170; + <I171> = 171; + <I172> = 172; + <I173> = 173; + <I174> = 174; + <I175> = 175; + <I176> = 176; + <I177> = 177; + <I178> = 178; + <I179> = 179; + <I180> = 180; + <I181> = 181; + <I182> = 182; + <I183> = 183; + <I184> = 184; + <I185> = 185; + <I186> = 186; + <I187> = 187; + <I188> = 188; + <I189> = 189; + <I190> = 190; + <FK13> = 191; + <FK14> = 192; + <FK15> = 193; + <FK16> = 194; + <FK17> = 195; + <FK18> = 196; + <FK19> = 197; + <FK20> = 198; + <FK21> = 199; + <FK22> = 200; + <FK23> = 201; + <FK24> = 202; + <MDSW> = 203; + <ALT> = 204; + <META> = 205; + <SUPR> = 206; + <HYPR> = 207; + <I208> = 208; + <I209> = 209; + <I210> = 210; + <I211> = 211; + <I212> = 212; + <I213> = 213; + <I214> = 214; + <I215> = 215; + <I216> = 216; + <I217> = 217; + <I218> = 218; + <I219> = 219; + <I220> = 220; + <I221> = 221; + <I222> = 222; + <I223> = 223; + <I224> = 224; + <I225> = 225; + <I226> = 226; + <I227> = 227; + <I228> = 228; + <I229> = 229; + <I230> = 230; + <I231> = 231; + <I232> = 232; + <I233> = 233; + <I234> = 234; + <I235> = 235; + <I236> = 236; + <I237> = 237; + <I238> = 238; + <I239> = 239; + <I240> = 240; + <I241> = 241; + <I242> = 242; + <I243> = 243; + <I244> = 244; + <I245> = 245; + <I246> = 246; + <I247> = 247; + <I248> = 248; + <I249> = 249; + <I250> = 250; + <I251> = 251; + <I252> = 252; + <I253> = 253; + <I254> = 254; + <I255> = 255; + <I372> = 372; + <I374> = 374; + indicator 1 = "Caps Lock"; + indicator 2 = "Num Lock"; + indicator 3 = "Scroll Lock"; + indicator 4 = "Compose"; + indicator 5 = "Kana"; + indicator 6 = "Sleep"; + indicator 7 = "Suspend"; + indicator 8 = "Mute"; + indicator 9 = "Misc"; + indicator 10 = "Mail"; + indicator 11 = "Charging"; + indicator 12 = "Shift Lock"; + indicator 13 = "Group 2"; + indicator 14 = "Mouse Keys"; + alias <AC12> = <BKSL>; + alias <MENU> = <COMP>; + alias <HZTG> = <TLDE>; + alias <LMTA> = <LWIN>; + alias <RMTA> = <RWIN>; + alias <ALGR> = <RALT>; + alias <KPPT> = <I129>; + alias <LatQ> = <AD01>; + alias <LatW> = <AD02>; + alias <LatE> = <AD03>; + alias <LatR> = <AD04>; + alias <LatT> = <AD05>; + alias <LatY> = <AD06>; + alias <LatU> = <AD07>; + alias <LatI> = <AD08>; + alias <LatO> = <AD09>; + alias <LatP> = <AD10>; + alias <LatA> = <AC01>; + alias <LatS> = <AC02>; + alias <LatD> = <AC03>; + alias <LatF> = <AC04>; + alias <LatG> = <AC05>; + alias <LatH> = <AC06>; + alias <LatJ> = <AC07>; + alias <LatK> = <AC08>; + alias <LatL> = <AC09>; + alias <LatZ> = <AB01>; + alias <LatX> = <AB02>; + alias <LatC> = <AB03>; + alias <LatV> = <AB04>; + alias <LatB> = <AB05>; + alias <LatN> = <AB06>; + alias <LatM> = <AB07>; +}; + +xkb_types "(unnamed)" { + virtual_modifiers NumLock,Alt,LevelThree,LAlt,RAlt,RControl,LControl,ScrollLock,LevelFive,AltGr,Meta,Super,Hyper; + + type "ONE_LEVEL" { + modifiers= none; + level_name[Level1]= "Any"; + }; + type "TWO_LEVEL" { + modifiers= Shift; + map[Shift]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + }; + type "ALPHABETIC" { + modifiers= Shift+Lock; + map[Shift]= Level2; + map[Lock]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "Caps"; + }; + type "SHIFT+ALT" { + modifiers= Shift+Alt; + map[Shift+Alt]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift+Alt"; + }; + type "PC_SUPER_LEVEL2" { + modifiers= Mod4; + map[Mod4]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "Super"; + }; + type "PC_CONTROL_LEVEL2" { + modifiers= Control; + map[Control]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "Control"; + }; + type "PC_LCONTROL_LEVEL2" { + modifiers= LControl; + map[LControl]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "LControl"; + }; + type "PC_RCONTROL_LEVEL2" { + modifiers= RControl; + map[RControl]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "RControl"; + }; + type "PC_ALT_LEVEL2" { + modifiers= Alt; + map[Alt]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "Alt"; + }; + type "PC_LALT_LEVEL2" { + modifiers= LAlt; + map[LAlt]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "LAlt"; + }; + type "PC_RALT_LEVEL2" { + modifiers= RAlt; + map[RAlt]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "RAlt"; + }; + type "CTRL+ALT" { + modifiers= Shift+Control+Alt+LevelThree; + map[Shift]= Level2; + preserve[Shift]= Shift; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + preserve[Shift+LevelThree]= Shift; + map[Control+Alt]= Level5; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + level_name[Level5]= "Ctrl+Alt"; + }; + type "LOCAL_EIGHT_LEVEL" { + modifiers= Shift+Lock+Control+LevelThree; + map[Shift]= Level2; + map[Lock]= Level2; + map[LevelThree]= Level3; + map[Shift+Lock+LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[Lock+LevelThree]= Level4; + map[Control]= Level5; + map[Shift+Lock+Control]= Level5; + map[Shift+Control]= Level6; + map[Lock+Control]= Level6; + map[Control+LevelThree]= Level7; + map[Shift+Lock+Control+LevelThree]= Level7; + map[Shift+Control+LevelThree]= Level8; + map[Lock+Control+LevelThree]= Level8; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Level3"; + level_name[Level4]= "Shift Level3"; + level_name[Level5]= "Ctrl"; + level_name[Level6]= "Shift Ctrl"; + level_name[Level7]= "Level3 Ctrl"; + level_name[Level8]= "Shift Level3 Ctrl"; + }; + type "THREE_LEVEL" { + modifiers= Shift+LevelThree; + map[Shift]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level3; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Level3"; + }; + type "EIGHT_LEVEL" { + modifiers= Shift+LevelThree+LevelFive; + map[Shift]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[LevelFive]= Level5; + map[Shift+LevelFive]= Level6; + map[LevelThree+LevelFive]= Level7; + map[Shift+LevelThree+LevelFive]= Level8; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + level_name[Level5]= "X"; + level_name[Level6]= "X Shift"; + level_name[Level7]= "X Alt Base"; + level_name[Level8]= "X Shift Alt"; + }; + type "EIGHT_LEVEL_ALPHABETIC" { + modifiers= Shift+Lock+LevelThree+LevelFive; + map[Shift]= Level2; + map[Lock]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[Lock+LevelThree]= Level4; + map[Shift+Lock+LevelThree]= Level3; + map[LevelFive]= Level5; + map[Shift+LevelFive]= Level6; + map[Lock+LevelFive]= Level6; + map[LevelThree+LevelFive]= Level7; + map[Shift+LevelThree+LevelFive]= Level8; + map[Lock+LevelThree+LevelFive]= Level8; + map[Shift+Lock+LevelThree+LevelFive]= Level7; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + level_name[Level5]= "X"; + level_name[Level6]= "X Shift"; + level_name[Level7]= "X Alt Base"; + level_name[Level8]= "X Shift Alt"; + }; + type "EIGHT_LEVEL_LEVEL_FIVE_LOCK" { + modifiers= Shift+Lock+NumLock+LevelThree+LevelFive; + map[Shift]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[LevelFive]= Level5; + map[Shift+LevelFive]= Level6; + preserve[Shift+LevelFive]= Shift; + map[LevelThree+LevelFive]= Level7; + map[Shift+LevelThree+LevelFive]= Level8; + map[NumLock]= Level5; + map[Shift+NumLock]= Level6; + preserve[Shift+NumLock]= Shift; + map[NumLock+LevelThree]= Level7; + map[Shift+NumLock+LevelThree]= Level8; + map[Shift+NumLock+LevelFive]= Level2; + map[NumLock+LevelThree+LevelFive]= Level3; + map[Shift+NumLock+LevelThree+LevelFive]= Level4; + map[Shift+Lock]= Level2; + map[Lock+LevelThree]= Level3; + map[Shift+Lock+LevelThree]= Level4; + map[Lock+LevelFive]= Level5; + map[Shift+Lock+LevelFive]= Level6; + preserve[Shift+Lock+LevelFive]= Shift; + map[Lock+LevelThree+LevelFive]= Level7; + map[Shift+Lock+LevelThree+LevelFive]= Level8; + map[Lock+NumLock]= Level5; + map[Shift+Lock+NumLock]= Level6; + preserve[Shift+Lock+NumLock]= Shift; + map[Lock+NumLock+LevelThree]= Level7; + map[Shift+Lock+NumLock+LevelThree]= Level8; + map[Shift+Lock+NumLock+LevelFive]= Level2; + map[Lock+NumLock+LevelThree+LevelFive]= Level3; + map[Shift+Lock+NumLock+LevelThree+LevelFive]= Level4; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + level_name[Level5]= "X"; + level_name[Level6]= "X Shift"; + level_name[Level7]= "X Alt Base"; + level_name[Level8]= "X Shift Alt"; + }; + type "EIGHT_LEVEL_ALPHABETIC_LEVEL_FIVE_LOCK" { + modifiers= Shift+Lock+NumLock+LevelThree+LevelFive; + map[Shift]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[LevelFive]= Level5; + map[Shift+LevelFive]= Level6; + preserve[Shift+LevelFive]= Shift; + map[LevelThree+LevelFive]= Level7; + map[Shift+LevelThree+LevelFive]= Level8; + map[NumLock]= Level5; + map[Shift+NumLock]= Level6; + preserve[Shift+NumLock]= Shift; + map[NumLock+LevelThree]= Level7; + map[Shift+NumLock+LevelThree]= Level8; + map[Shift+NumLock+LevelFive]= Level2; + map[NumLock+LevelThree+LevelFive]= Level3; + map[Shift+NumLock+LevelThree+LevelFive]= Level4; + map[Lock]= Level2; + map[Lock+LevelThree]= Level3; + map[Shift+Lock+LevelThree]= Level4; + map[Lock+LevelFive]= Level5; + map[Shift+Lock+LevelFive]= Level6; + map[Lock+LevelThree+LevelFive]= Level7; + map[Shift+Lock+LevelThree+LevelFive]= Level8; + map[Lock+NumLock]= Level5; + map[Shift+Lock+NumLock]= Level6; + map[Lock+NumLock+LevelThree]= Level7; + map[Shift+Lock+NumLock+LevelThree]= Level8; + map[Lock+NumLock+LevelFive]= Level2; + map[Lock+NumLock+LevelThree+LevelFive]= Level4; + map[Shift+Lock+NumLock+LevelThree+LevelFive]= Level3; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + level_name[Level5]= "X"; + level_name[Level6]= "X Shift"; + level_name[Level7]= "X Alt Base"; + level_name[Level8]= "X Shift Alt"; + }; + type "EIGHT_LEVEL_SEMIALPHABETIC" { + modifiers= Shift+Lock+LevelThree+LevelFive; + map[Shift]= Level2; + map[Lock]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[Lock+LevelThree]= Level3; + preserve[Lock+LevelThree]= Lock; + map[Shift+Lock+LevelThree]= Level4; + preserve[Shift+Lock+LevelThree]= Lock; + map[LevelFive]= Level5; + map[Shift+LevelFive]= Level6; + map[Lock+LevelFive]= Level6; + preserve[Lock+LevelFive]= Lock; + map[Shift+Lock+LevelFive]= Level6; + preserve[Shift+Lock+LevelFive]= Lock; + map[LevelThree+LevelFive]= Level7; + map[Shift+LevelThree+LevelFive]= Level8; + map[Lock+LevelThree+LevelFive]= Level7; + preserve[Lock+LevelThree+LevelFive]= Lock; + map[Shift+Lock+LevelThree+LevelFive]= Level8; + preserve[Shift+Lock+LevelThree+LevelFive]= Lock; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + level_name[Level5]= "X"; + level_name[Level6]= "X Shift"; + level_name[Level7]= "X Alt Base"; + level_name[Level8]= "X Shift Alt"; + }; + type "FOUR_LEVEL" { + modifiers= Shift+LevelThree; + map[Shift]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + }; + type "FOUR_LEVEL_ALPHABETIC" { + modifiers= Shift+Lock+LevelThree; + map[Shift]= Level2; + map[Lock]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[Lock+LevelThree]= Level4; + map[Shift+Lock+LevelThree]= Level3; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + }; + type "FOUR_LEVEL_SEMIALPHABETIC" { + modifiers= Shift+Lock+LevelThree; + map[Shift]= Level2; + map[Lock]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[Lock+LevelThree]= Level3; + preserve[Lock+LevelThree]= Lock; + map[Shift+Lock+LevelThree]= Level4; + preserve[Shift+Lock+LevelThree]= Lock; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + }; + type "FOUR_LEVEL_MIXED_KEYPAD" { + modifiers= Shift+NumLock+LevelThree; + map[NumLock]= Level2; + map[Shift]= Level2; + map[LevelThree]= Level3; + map[NumLock+LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[Shift+NumLock+LevelThree]= Level4; + level_name[Level1]= "Base"; + level_name[Level2]= "Number"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + }; + type "FOUR_LEVEL_X" { + modifiers= Shift+Control+Alt+LevelThree; + map[LevelThree]= Level2; + map[Shift+LevelThree]= Level3; + map[Control+Alt]= Level4; + level_name[Level1]= "Base"; + level_name[Level2]= "Alt Base"; + level_name[Level3]= "Shift Alt"; + level_name[Level4]= "Ctrl+Alt"; + }; + type "SEPARATE_CAPS_AND_SHIFT_ALPHABETIC" { + modifiers= Shift+Lock+LevelThree; + map[Shift]= Level2; + map[Lock]= Level4; + preserve[Lock]= Lock; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[Lock+LevelThree]= Level3; + preserve[Lock+LevelThree]= Lock; + map[Shift+Lock+LevelThree]= Level3; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "AltGr Base"; + level_name[Level4]= "Shift AltGr"; + }; + type "FOUR_LEVEL_PLUS_LOCK" { + modifiers= Shift+Lock+LevelThree; + map[Shift]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[Lock]= Level5; + map[Shift+Lock]= Level2; + map[Lock+LevelThree]= Level3; + map[Shift+Lock+LevelThree]= Level4; + level_name[Level1]= "Base"; + level_name[Level2]= "Shift"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Shift Alt"; + level_name[Level5]= "Lock"; + }; + type "KEYPAD" { + modifiers= Shift+NumLock; + map[Shift]= Level2; + map[NumLock]= Level2; + level_name[Level1]= "Base"; + level_name[Level2]= "Number"; + }; + type "FOUR_LEVEL_KEYPAD" { + modifiers= Shift+NumLock+LevelThree; + map[Shift]= Level2; + map[NumLock]= Level2; + map[LevelThree]= Level3; + map[Shift+LevelThree]= Level4; + map[NumLock+LevelThree]= Level4; + map[Shift+NumLock+LevelThree]= Level3; + level_name[Level1]= "Base"; + level_name[Level2]= "Number"; + level_name[Level3]= "Alt Base"; + level_name[Level4]= "Alt Number"; + }; +}; + +xkb_compatibility "(unnamed)" { + virtual_modifiers NumLock,Alt,LevelThree,LAlt,RAlt,RControl,LControl,ScrollLock,LevelFive,AltGr,Meta,Super,Hyper; + + interpret.useModMapMods= AnyLevel; + interpret.repeat= False; + interpret ISO_Level2_Latch+Exactly(Shift) { + useModMapMods=level1; + action= LatchMods(modifiers=Shift,clearLocks,latchToLock); + }; + interpret Shift_Lock+AnyOf(Shift+Lock) { + action= LockMods(modifiers=Shift); + }; + interpret Num_Lock+AnyOf(all) { + virtualModifier= NumLock; + action= LockMods(modifiers=NumLock); + }; + interpret ISO_Level3_Shift+AnyOf(all) { + virtualModifier= LevelThree; + useModMapMods=level1; + action= SetMods(modifiers=LevelThree,clearLocks); + }; + interpret ISO_Level3_Latch+AnyOf(all) { + virtualModifier= LevelThree; + useModMapMods=level1; + action= LatchMods(modifiers=LevelThree,clearLocks,latchToLock); + }; + interpret ISO_Level3_Lock+AnyOf(all) { + virtualModifier= LevelThree; + useModMapMods=level1; + action= LockMods(modifiers=LevelThree); + }; + interpret Alt_L+AnyOf(all) { + virtualModifier= Alt; + action= SetMods(modifiers=modMapMods,clearLocks); + }; + interpret Alt_R+AnyOf(all) { + virtualModifier= Alt; + action= SetMods(modifiers=modMapMods,clearLocks); + }; + interpret Meta_L+AnyOf(all) { + virtualModifier= Meta; + action= SetMods(modifiers=modMapMods,clearLocks); + }; + interpret Meta_R+AnyOf(all) { + virtualModifier= Meta; + action= SetMods(modifiers=modMapMods,clearLocks); + }; + interpret Super_L+AnyOf(all) { + virtualModifier= Super; + action= SetMods(modifiers=modMapMods,clearLocks); + }; + interpret Super_R+AnyOf(all) { + virtualModifier= Super; + action= SetMods(modifiers=modMapMods,clearLocks); + }; + interpret Hyper_L+AnyOf(all) { + virtualModifier= Hyper; + action= SetMods(modifiers=modMapMods,clearLocks); + }; + interpret Hyper_R+AnyOf(all) { + virtualModifier= Hyper; + action= SetMods(modifiers=modMapMods,clearLocks); + }; + interpret Scroll_Lock+AnyOf(all) { + virtualModifier= ScrollLock; + action= LockMods(modifiers=modMapMods); + }; + interpret ISO_Level5_Shift+AnyOf(all) { + virtualModifier= LevelFive; + useModMapMods=level1; + action= SetMods(modifiers=LevelFive,clearLocks); + }; + interpret ISO_Level5_Latch+AnyOf(all) { + virtualModifier= LevelFive; + useModMapMods=level1; + action= LatchMods(modifiers=LevelFive,clearLocks,latchToLock); + }; + interpret ISO_Level5_Lock+AnyOf(all) { + virtualModifier= LevelFive; + useModMapMods=level1; + action= LockMods(modifiers=LevelFive); + }; + interpret Mode_switch+AnyOfOrNone(all) { + virtualModifier= AltGr; + useModMapMods=level1; + action= SetGroup(group=+1); + }; + interpret ISO_Level3_Shift+AnyOfOrNone(all) { + action= SetMods(modifiers=LevelThree,clearLocks); + }; + interpret ISO_Level3_Latch+AnyOfOrNone(all) { + action= LatchMods(modifiers=LevelThree,clearLocks,latchToLock); + }; + interpret ISO_Level3_Lock+AnyOfOrNone(all) { + action= LockMods(modifiers=LevelThree); + }; + interpret ISO_Group_Latch+AnyOfOrNone(all) { + virtualModifier= AltGr; + useModMapMods=level1; + action= LatchGroup(group=2); + }; + interpret ISO_Next_Group+AnyOfOrNone(all) { + virtualModifier= AltGr; + useModMapMods=level1; + action= LockGroup(group=+1); + }; + interpret ISO_Prev_Group+AnyOfOrNone(all) { + virtualModifier= AltGr; + useModMapMods=level1; + action= LockGroup(group=-1); + }; + interpret ISO_First_Group+AnyOfOrNone(all) { + action= LockGroup(group=1); + }; + interpret ISO_Last_Group+AnyOfOrNone(all) { + action= LockGroup(group=2); + }; + interpret KP_1+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=-1,y=+1); + }; + interpret KP_End+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=-1,y=+1); + }; + interpret KP_2+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+0,y=+1); + }; + interpret KP_Down+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+0,y=+1); + }; + interpret KP_3+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+1,y=+1); + }; + interpret KP_Next+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+1,y=+1); + }; + interpret KP_4+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=-1,y=+0); + }; + interpret KP_Left+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=-1,y=+0); + }; + interpret KP_6+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+1,y=+0); + }; + interpret KP_Right+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+1,y=+0); + }; + interpret KP_7+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=-1,y=-1); + }; + interpret KP_Home+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=-1,y=-1); + }; + interpret KP_8+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+0,y=-1); + }; + interpret KP_Up+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+0,y=-1); + }; + interpret KP_9+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+1,y=-1); + }; + interpret KP_Prior+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+1,y=-1); + }; + interpret KP_5+AnyOfOrNone(all) { + repeat= True; + action= PtrBtn(button=default); + }; + interpret KP_Begin+AnyOfOrNone(all) { + repeat= True; + action= PtrBtn(button=default); + }; + interpret KP_F2+AnyOfOrNone(all) { + repeat= True; + action= SetPtrDflt(affect=button,button=1); + }; + interpret KP_Divide+AnyOfOrNone(all) { + repeat= True; + action= SetPtrDflt(affect=button,button=1); + }; + interpret KP_F3+AnyOfOrNone(all) { + repeat= True; + action= SetPtrDflt(affect=button,button=2); + }; + interpret KP_Multiply+AnyOfOrNone(all) { + repeat= True; + action= SetPtrDflt(affect=button,button=2); + }; + interpret KP_F4+AnyOfOrNone(all) { + repeat= True; + action= SetPtrDflt(affect=button,button=3); + }; + interpret KP_Subtract+AnyOfOrNone(all) { + repeat= True; + action= SetPtrDflt(affect=button,button=3); + }; + interpret KP_Separator+AnyOfOrNone(all) { + repeat= True; + action= PtrBtn(button=default,count=2); + }; + interpret KP_Add+AnyOfOrNone(all) { + repeat= True; + action= PtrBtn(button=default,count=2); + }; + interpret KP_0+AnyOfOrNone(all) { + repeat= True; + action= LockPtrBtn(button=default,affect=lock); + }; + interpret KP_Insert+AnyOfOrNone(all) { + repeat= True; + action= LockPtrBtn(button=default,affect=lock); + }; + interpret KP_Decimal+AnyOfOrNone(all) { + repeat= True; + action= LockPtrBtn(button=default,affect=unlock); + }; + interpret KP_Delete+AnyOfOrNone(all) { + repeat= True; + action= LockPtrBtn(button=default,affect=unlock); + }; + interpret F25+AnyOfOrNone(all) { + repeat= True; + action= SetPtrDflt(affect=button,button=1); + }; + interpret F26+AnyOfOrNone(all) { + repeat= True; + action= SetPtrDflt(affect=button,button=2); + }; + interpret F27+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=-1,y=-1); + }; + interpret F29+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+1,y=-1); + }; + interpret F31+AnyOfOrNone(all) { + repeat= True; + action= PtrBtn(button=default); + }; + interpret F33+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=-1,y=+1); + }; + interpret F35+AnyOfOrNone(all) { + repeat= True; + action= MovePtr(x=+1,y=+1); + }; + interpret Pointer_Button_Dflt+AnyOfOrNone(all) { + action= PtrBtn(button=default); + }; + interpret Pointer_Button1+AnyOfOrNone(all) { + action= PtrBtn(button=1); + }; + interpret Pointer_Button2+AnyOfOrNone(all) { + action= PtrBtn(button=2); + }; + interpret Pointer_Button3+AnyOfOrNone(all) { + action= PtrBtn(button=3); + }; + interpret Pointer_DblClick_Dflt+AnyOfOrNone(all) { + action= PtrBtn(button=default,count=2); + }; + interpret Pointer_DblClick1+AnyOfOrNone(all) { + action= PtrBtn(button=1,count=2); + }; + interpret Pointer_DblClick2+AnyOfOrNone(all) { + action= PtrBtn(button=2,count=2); + }; + interpret Pointer_DblClick3+AnyOfOrNone(all) { + action= PtrBtn(button=3,count=2); + }; + interpret Pointer_Drag_Dflt+AnyOfOrNone(all) { + action= LockPtrBtn(button=default); + }; + interpret Pointer_Drag1+AnyOfOrNone(all) { + action= LockPtrBtn(button=1); + }; + interpret Pointer_Drag2+AnyOfOrNone(all) { + action= LockPtrBtn(button=2); + }; + interpret Pointer_Drag3+AnyOfOrNone(all) { + action= LockPtrBtn(button=3); + }; + interpret Pointer_EnableKeys+AnyOfOrNone(all) { + action= LockControls(controls=MouseKeys); + }; + interpret Pointer_Accelerate+AnyOfOrNone(all) { + action= LockControls(controls=MouseKeysAccel); + }; + interpret Pointer_DfltBtnNext+AnyOfOrNone(all) { + action= SetPtrDflt(affect=button,button=+1); + }; + interpret Pointer_DfltBtnPrev+AnyOfOrNone(all) { + action= SetPtrDflt(affect=button,button=-1); + }; + interpret AccessX_Enable+AnyOfOrNone(all) { + action= LockControls(controls=AccessXKeys); + }; + interpret AccessX_Feedback_Enable+AnyOfOrNone(all) { + action= LockControls(controls=AccessXFeedback); + }; + interpret RepeatKeys_Enable+AnyOfOrNone(all) { + action= LockControls(controls=RepeatKeys); + }; + interpret SlowKeys_Enable+AnyOfOrNone(all) { + action= LockControls(controls=SlowKeys); + }; + interpret BounceKeys_Enable+AnyOfOrNone(all) { + action= LockControls(controls=BounceKeys); + }; + interpret StickyKeys_Enable+AnyOfOrNone(all) { + action= LockControls(controls=StickyKeys); + }; + interpret MouseKeys_Enable+AnyOfOrNone(all) { + action= LockControls(controls=MouseKeys); + }; + interpret MouseKeys_Accel_Enable+AnyOfOrNone(all) { + action= LockControls(controls=MouseKeysAccel); + }; + interpret Overlay1_Enable+AnyOfOrNone(all) { + action= LockControls(controls=none); + }; + interpret Overlay2_Enable+AnyOfOrNone(all) { + action= LockControls(controls=none); + }; + interpret AudibleBell_Enable+AnyOfOrNone(all) { + action= LockControls(controls=AudibleBell); + }; + interpret Terminate_Server+AnyOfOrNone(all) { + action= Terminate(); + }; + interpret Alt_L+AnyOfOrNone(all) { + action= SetMods(modifiers=Alt,clearLocks); + }; + interpret Alt_R+AnyOfOrNone(all) { + action= SetMods(modifiers=Alt,clearLocks); + }; + interpret Meta_L+AnyOfOrNone(all) { + action= SetMods(modifiers=Meta,clearLocks); + }; + interpret Meta_R+AnyOfOrNone(all) { + action= SetMods(modifiers=Meta,clearLocks); + }; + interpret Super_L+AnyOfOrNone(all) { + action= SetMods(modifiers=Super,clearLocks); + }; + interpret Super_R+AnyOfOrNone(all) { + action= SetMods(modifiers=Super,clearLocks); + }; + interpret Hyper_L+AnyOfOrNone(all) { + action= SetMods(modifiers=Hyper,clearLocks); + }; + interpret Hyper_R+AnyOfOrNone(all) { + action= SetMods(modifiers=Hyper,clearLocks); + }; + interpret Shift_L+AnyOfOrNone(all) { + action= SetMods(modifiers=Shift,clearLocks); + }; + interpret XF86Switch_VT_1+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=1,!same); + }; + interpret XF86Switch_VT_2+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=2,!same); + }; + interpret XF86Switch_VT_3+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=3,!same); + }; + interpret XF86Switch_VT_4+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=4,!same); + }; + interpret XF86Switch_VT_5+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=5,!same); + }; + interpret XF86Switch_VT_6+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=6,!same); + }; + interpret XF86Switch_VT_7+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=7,!same); + }; + interpret XF86Switch_VT_8+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=8,!same); + }; + interpret XF86Switch_VT_9+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=9,!same); + }; + interpret XF86Switch_VT_10+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=10,!same); + }; + interpret XF86Switch_VT_11+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=11,!same); + }; + interpret XF86Switch_VT_12+AnyOfOrNone(all) { + repeat= True; + action= SwitchScreen(screen=12,!same); + }; + interpret XF86LogGrabInfo+AnyOfOrNone(all) { + repeat= True; + action= Private(type=0x86,data[0]=0x50,data[1]=0x72,data[2]=0x47,data[3]=0x72,data[4]=0x62,data[5]=0x73,data[6]=0x00); + }; + interpret XF86LogWindowTree+AnyOfOrNone(all) { + repeat= True; + action= Private(type=0x86,data[0]=0x50,data[1]=0x72,data[2]=0x57,data[3]=0x69,data[4]=0x6e,data[5]=0x73,data[6]=0x00); + }; + interpret XF86Next_VMode+AnyOfOrNone(all) { + repeat= True; + action= Private(type=0x86,data[0]=0x2b,data[1]=0x56,data[2]=0x4d,data[3]=0x6f,data[4]=0x64,data[5]=0x65,data[6]=0x00); + }; + interpret XF86Prev_VMode+AnyOfOrNone(all) { + repeat= True; + action= Private(type=0x86,data[0]=0x2d,data[1]=0x56,data[2]=0x4d,data[3]=0x6f,data[4]=0x64,data[5]=0x65,data[6]=0x00); + }; + interpret ISO_Level5_Shift+AnyOfOrNone(all) { + action= SetMods(modifiers=LevelFive,clearLocks); + }; + interpret ISO_Level5_Latch+AnyOfOrNone(all) { + action= LatchMods(modifiers=LevelFive,clearLocks,latchToLock); + }; + interpret ISO_Level5_Lock+AnyOfOrNone(all) { + action= LockMods(modifiers=LevelFive); + }; + interpret Caps_Lock+AnyOfOrNone(all) { + action= LockMods(modifiers=Lock); + }; + interpret Any+Exactly(Lock) { + action= LockMods(modifiers=Lock); + }; + interpret Any+AnyOf(all) { + action= SetMods(modifiers=modMapMods,clearLocks); + }; + indicator "Caps Lock" { + whichModState= locked; + modifiers= Lock; + }; + indicator "Num Lock" { + whichModState= locked; + modifiers= NumLock; + }; + indicator "Scroll Lock" { + whichModState= locked; + modifiers= ScrollLock; + }; + indicator "Shift Lock" { + whichModState= locked; + modifiers= Shift; + }; + indicator "Group 2" { + groups= 0xfe; + }; + indicator "Mouse Keys" { + controls= MouseKeys; + }; +}; + +xkb_symbols "(unnamed)" { + name[group1]="English (US)"; + + key <ESC> { [ Escape ] }; + key <AE01> { [ 1, exclam ] }; + key <AE02> { [ 2, at ] }; + key <AE03> { [ 3, numbersign ] }; + key <AE04> { [ 4, dollar ] }; + key <AE05> { [ 5, percent ] }; + key <AE06> { [ 6, asciicircum ] }; + key <AE07> { [ 7, ampersand ] }; + key <AE08> { [ 8, asterisk ] }; + key <AE09> { [ 9, parenleft ] }; + key <AE10> { [ 0, parenright ] }; + key <AE11> { [ minus, underscore ] }; + key <AE12> { [ equal, plus ] }; + key <BKSP> { [ BackSpace, BackSpace ] }; + key <TAB> { [ Tab, ISO_Left_Tab ] }; + key <AD01> { [ q, Q ] }; + key <AD02> { [ w, W ] }; + key <AD03> { [ e, E ] }; + key <AD04> { [ r, R ] }; + key <AD05> { [ t, T ] }; + key <AD06> { [ y, Y ] }; + key <AD07> { [ u, U ] }; + key <AD08> { [ i, I ] }; + key <AD09> { [ o, O ] }; + key <AD10> { [ p, P ] }; + key <AD11> { [ bracketleft, braceleft ] }; + key <AD12> { [ bracketright, braceright ] }; + key <RTRN> { [ Return ] }; + key <LCTL> { [ Control_L ] }; + key <AC01> { [ a, A ] }; + key <AC02> { [ s, S ] }; + key <AC03> { [ d, D ] }; + key <AC04> { [ f, F ] }; + key <AC05> { [ g, G ] }; + key <AC06> { [ h, H ] }; + key <AC07> { [ j, J ] }; + key <AC08> { [ k, K ] }; + key <AC09> { [ l, L ] }; + key <AC10> { [ semicolon, colon ] }; + key <AC11> { [ apostrophe, quotedbl ] }; + key <TLDE> { [ grave, asciitilde ] }; + key <LFSH> { [ Shift_L ] }; + key <BKSL> { [ backslash, bar ] }; + key <AB01> { [ z, Z ] }; + key <AB02> { [ x, X ] }; + key <AB03> { [ c, C ] }; + key <AB04> { [ v, V ] }; + key <AB05> { [ b, B ] }; + key <AB06> { [ n, N ] }; + key <AB07> { [ m, M ] }; + key <AB08> { [ comma, less ] }; + key <AB09> { [ period, greater ] }; + key <AB10> { [ slash, question ] }; + key <RTSH> { [ Shift_R ] }; + key <KPMU> { + type= "CTRL+ALT", + symbols[Group1]= [ KP_Multiply, KP_Multiply, KP_Multiply, KP_Multiply, XF86ClearGrab ] + }; + key <LALT> { [ Alt_L, Meta_L ] }; + key <SPCE> { [ space ] }; + key <CAPS> { [ Caps_Lock ] }; + key <FK01> { + type= "CTRL+ALT", + symbols[Group1]= [ F1, F1, F1, F1, XF86Switch_VT_1 ] + }; + key <FK02> { + type= "CTRL+ALT", + symbols[Group1]= [ F2, F2, F2, F2, XF86Switch_VT_2 ] + }; + key <FK03> { + type= "CTRL+ALT", + symbols[Group1]= [ F3, F3, F3, F3, XF86Switch_VT_3 ] + }; + key <FK04> { + type= "CTRL+ALT", + symbols[Group1]= [ F4, F4, F4, F4, XF86Switch_VT_4 ] + }; + key <FK05> { + type= "CTRL+ALT", + symbols[Group1]= [ F5, F5, F5, F5, XF86Switch_VT_5 ] + }; + key <FK06> { + type= "CTRL+ALT", + symbols[Group1]= [ F6, F6, F6, F6, XF86Switch_VT_6 ] + }; + key <FK07> { + type= "CTRL+ALT", + symbols[Group1]= [ F7, F7, F7, F7, XF86Switch_VT_7 ] + }; + key <FK08> { + type= "CTRL+ALT", + symbols[Group1]= [ F8, F8, F8, F8, XF86Switch_VT_8 ] + }; + key <FK09> { + type= "CTRL+ALT", + symbols[Group1]= [ F9, F9, F9, F9, XF86Switch_VT_9 ] + }; + key <FK10> { + type= "CTRL+ALT", + symbols[Group1]= [ F10, F10, F10, F10, XF86Switch_VT_10 ] + }; + key <NMLK> { [ Num_Lock ] }; + key <SCLK> { [ Scroll_Lock ] }; + key <KP7> { [ KP_Home, KP_7 ] }; + key <KP8> { [ KP_Up, KP_8 ] }; + key <KP9> { [ KP_Prior, KP_9 ] }; + key <KPSU> { + type= "CTRL+ALT", + symbols[Group1]= [ KP_Subtract, KP_Subtract, KP_Subtract, KP_Subtract, XF86Prev_VMode ] + }; + key <KP4> { [ KP_Left, KP_4 ] }; + key <KP5> { [ KP_Begin, KP_5 ] }; + key <KP6> { [ KP_Right, KP_6 ] }; + key <KPAD> { + type= "CTRL+ALT", + symbols[Group1]= [ KP_Add, KP_Add, KP_Add, KP_Add, XF86Next_VMode ] + }; + key <KP1> { [ KP_End, KP_1 ] }; + key <KP2> { [ KP_Down, KP_2 ] }; + key <KP3> { [ KP_Next, KP_3 ] }; + key <KP0> { [ KP_Insert, KP_0 ] }; + key <KPDL> { [ KP_Delete, KP_Decimal ] }; + key <LVL3> { [ ISO_Level3_Shift ] }; + key <LSGT> { [ less, greater, bar, brokenbar ] }; + key <FK11> { + type= "CTRL+ALT", + symbols[Group1]= [ F11, F11, F11, F11, XF86Switch_VT_11 ] + }; + key <FK12> { + type= "CTRL+ALT", + symbols[Group1]= [ F12, F12, F12, F12, XF86Switch_VT_12 ] + }; + key <KATA> { [ Katakana ] }; + key <HIRA> { [ Hiragana ] }; + key <HENK> { [ Henkan_Mode ] }; + key <HKTG> { [ Hiragana_Katakana ] }; + key <MUHE> { [ Muhenkan ] }; + key <KPEN> { [ KP_Enter ] }; + key <RCTL> { [ Control_R ] }; + key <KPDV> { + type= "CTRL+ALT", + symbols[Group1]= [ KP_Divide, KP_Divide, KP_Divide, KP_Divide, XF86Ungrab ] + }; + key <PRSC> { + type= "PC_ALT_LEVEL2", + symbols[Group1]= [ Print, Sys_Req ] + }; + key <RALT> { + type= "TWO_LEVEL", + symbols[Group1]= [ Alt_R, Meta_R ] + }; + key <LNFD> { [ Linefeed ] }; + key <HOME> { [ Home ] }; + key <UP> { [ Up ] }; + key <PGUP> { [ Prior ] }; + key <LEFT> { [ Left ] }; + key <RGHT> { [ Right ] }; + key <END> { [ End ] }; + key <DOWN> { [ Down ] }; + key <PGDN> { [ Next ] }; + key <INS> { [ Insert ] }; + key <DELE> { [ Delete ] }; + key <MUTE> { [ XF86AudioMute ] }; + key <VOL-> { [ XF86AudioLowerVolume ] }; + key <VOL+> { [ XF86AudioRaiseVolume ] }; + key <POWR> { [ XF86PowerOff ] }; + key <KPEQ> { [ KP_Equal ] }; + key <I126> { [ plusminus ] }; + key <PAUS> { + type= "PC_CONTROL_LEVEL2", + symbols[Group1]= [ Pause, Break ] + }; + key <I128> { [ XF86LaunchA ] }; + key <I129> { [ KP_Decimal, KP_Decimal ] }; + key <HNGL> { [ Hangul ] }; + key <HJCV> { [ Hangul_Hanja ] }; + key <LWIN> { [ Super_L ] }; + key <RWIN> { [ Super_R ] }; + key <COMP> { [ Menu ] }; + key <STOP> { [ Cancel ] }; + key <AGAI> { [ Redo ] }; + key <PROP> { [ SunProps ] }; + key <UNDO> { [ Undo ] }; + key <FRNT> { [ SunFront ] }; + key <COPY> { [ XF86Copy ] }; + key <OPEN> { [ XF86Open ] }; + key <PAST> { [ XF86Paste ] }; + key <FIND> { [ Find ] }; + key <CUT> { [ XF86Cut ] }; + key <HELP> { [ Help ] }; + key <I147> { [ XF86MenuKB ] }; + key <I148> { [ XF86Calculator ] }; + key <I150> { [ XF86Sleep ] }; + key <I151> { [ XF86WakeUp ] }; + key <I152> { [ XF86Explorer ] }; + key <I153> { [ XF86Send ] }; + key <I155> { [ XF86Xfer ] }; + key <I156> { [ XF86Launch1 ] }; + key <I157> { [ XF86Launch2 ] }; + key <I158> { [ XF86WWW ] }; + key <I159> { [ XF86DOS ] }; + key <I160> { [ XF86ScreenSaver ] }; + key <I161> { [ XF86RotateWindows ] }; + key <I162> { [ XF86TaskPane ] }; + key <I163> { [ XF86Mail ] }; + key <I164> { [ XF86Favorites ] }; + key <I165> { [ XF86MyComputer ] }; + key <I166> { [ XF86Back ] }; + key <I167> { [ XF86Forward ] }; + key <I169> { [ XF86Eject ] }; + key <I170> { [ XF86Eject, XF86Eject ] }; + key <I171> { [ XF86AudioNext ] }; + key <I172> { [ XF86AudioPlay, XF86AudioPause ] }; + key <I173> { [ XF86AudioPrev ] }; + key <I174> { [ XF86AudioStop, XF86Eject ] }; + key <I175> { [ XF86AudioRecord ] }; + key <I176> { [ XF86AudioRewind ] }; + key <I177> { [ XF86Phone ] }; + key <I179> { [ XF86Tools ] }; + key <I180> { [ XF86HomePage ] }; + key <I181> { [ XF86Reload ] }; + key <I182> { [ XF86Close ] }; + key <I185> { [ XF86ScrollUp ] }; + key <I186> { [ XF86ScrollDown ] }; + key <I187> { [ parenleft ] }; + key <I188> { [ parenright ] }; + key <I189> { [ XF86New ] }; + key <I190> { [ Redo ] }; + key <FK13> { [ XF86Tools ] }; + key <FK14> { [ XF86Launch5 ] }; + key <FK15> { [ XF86Launch6 ] }; + key <FK16> { [ XF86Launch7 ] }; + key <FK17> { [ XF86Launch8 ] }; + key <FK18> { [ XF86Launch9 ] }; + key <FK20> { [ XF86AudioMicMute ] }; + key <FK21> { [ XF86TouchpadToggle ] }; + key <FK22> { [ XF86TouchpadOn ] }; + key <FK23> { [ XF86TouchpadOff ] }; + key <MDSW> { [ Mode_switch ] }; + key <ALT> { [ NoSymbol, Alt_L ] }; + key <META> { [ NoSymbol, Meta_L ] }; + key <SUPR> { [ NoSymbol, Super_L ] }; + key <HYPR> { [ NoSymbol, Hyper_L ] }; + key <I208> { [ XF86AudioPlay ] }; + key <I209> { [ XF86AudioPause ] }; + key <I210> { [ XF86Launch3 ] }; + key <I211> { [ XF86Launch4 ] }; + key <I212> { [ XF86LaunchB ] }; + key <I213> { [ XF86Suspend ] }; + key <I214> { [ XF86Close ] }; + key <I215> { [ XF86AudioPlay ] }; + key <I216> { [ XF86AudioForward ] }; + key <I218> { [ Print ] }; + key <I220> { [ XF86WebCam ] }; + key <I223> { [ XF86Mail ] }; + key <I224> { [ XF86Messenger ] }; + key <I225> { [ XF86Search ] }; + key <I226> { [ XF86Go ] }; + key <I227> { [ XF86Finance ] }; + key <I228> { [ XF86Game ] }; + key <I229> { [ XF86Shop ] }; + key <I231> { [ Cancel ] }; + key <I232> { [ XF86MonBrightnessDown ] }; + key <I233> { [ XF86MonBrightnessUp ] }; + key <I234> { [ XF86AudioMedia ] }; + key <I235> { [ XF86Display ] }; + key <I236> { [ XF86KbdLightOnOff ] }; + key <I237> { [ XF86KbdBrightnessDown ] }; + key <I238> { [ XF86KbdBrightnessUp ] }; + key <I239> { [ XF86Send ] }; + key <I240> { [ XF86Reply ] }; + key <I241> { [ XF86MailForward ] }; + key <I242> { [ XF86Save ] }; + key <I243> { [ XF86Documents ] }; + key <I244> { [ XF86Battery ] }; + key <I245> { [ XF86Bluetooth ] }; + key <I246> { [ XF86WLAN ] }; + key <I254> { [ XF86WWAN ] }; + key <I255> { [ XF86RFKill ] }; + key <I372> { [ XF86Favorites ] }; + key <I374> { [ XF86Keyboard ] }; + modifier_map Shift { <LFSH>, <RTSH> }; + modifier_map Lock { <CAPS> }; + modifier_map Control { <LCTL>, <RCTL> }; + modifier_map Mod1 { <LALT>, <RALT>, <META> }; + modifier_map Mod2 { <NMLK> }; + modifier_map Mod4 { <LWIN>, <RWIN>, <SUPR>, <HYPR> }; + modifier_map Mod5 { <LVL3>, <MDSW> }; +}; + +}; + diff --git a/Sources/App/OwlAppDelegate.h b/Sources/App/OwlAppDelegate.h new file mode 100644 index 0000000..28d6c52 --- /dev/null +++ b/Sources/App/OwlAppDelegate.h @@ -0,0 +1,23 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> + +@interface OwlAppDelegate : NSObject <NSApplicationDelegate> + +@end diff --git a/Sources/App/OwlAppDelegate.m b/Sources/App/OwlAppDelegate.m new file mode 100644 index 0000000..c0ebaf8 --- /dev/null +++ b/Sources/App/OwlAppDelegate.m @@ -0,0 +1,43 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlAppDelegate.h" +#import "OwlServer.h" + +@implementation OwlAppDelegate + +- (void) applicationDidFinishLaunching: (NSNotification *) notification { + // Instantiate the server. If sucessful, this will + // automatically start serving the clients. + OwlServer *server = [OwlServer sharedServer]; + if (server == nil) { + // It should have already displayed an error message, + // so we just to have to exit. We call exit() directly + // instead of using -[NSApp terminate:] in order to + // have it return the non-zero exit code. We should + // not have any unsaved documents anyway. + exit(1); + } +} + +- (void) applicationWillBecomeActive: (NSNotification *) notification { + // Force the pasteboard to reload its contents. + [[NSPasteboard generalPasteboard] types]; +} + +@end diff --git a/Sources/App/OwlKnownClientsManager.h b/Sources/App/OwlKnownClientsManager.h new file mode 100644 index 0000000..aded6e9 --- /dev/null +++ b/Sources/App/OwlKnownClientsManager.h @@ -0,0 +1,31 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> + + +@interface OwlKnownClientsManager : NSObject { + IBOutlet NSMenu *_clientsMenu; + NSArray *_defaultClients; + NSArray *_clients; +} + +- (IBAction) startClient: (id) sender; +- (IBAction) configureClients: (id) sender; + +@end diff --git a/Sources/App/OwlKnownClientsManager.m b/Sources/App/OwlKnownClientsManager.m new file mode 100644 index 0000000..2f33520 --- /dev/null +++ b/Sources/App/OwlKnownClientsManager.m @@ -0,0 +1,80 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlKnownClientsManager.h" + + +@implementation OwlKnownClientsManager + +- (void) createMenuItemForIndex: (NSUInteger) index + clientPath: (NSString *) clientPath +{ + NSString *title = [clientPath lastPathComponent]; + NSMenuItem *item = [[NSMenuItem alloc] initWithTitle: title + action: @selector(startClient:) + keyEquivalent: @""]; + [item setTarget: self]; + [item setTag: index]; + [_clientsMenu addItem: item]; + [item release]; +} + +- (void) update { + [_clients release]; + NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults]; + NSArray *customClients = [defaults arrayForKey: @"CustomClients"]; + _clients = [[_defaultClients arrayByAddingObjectsFromArray: customClients] retain]; + + [_clientsMenu removeAllItems]; + + NSUInteger size = [_clients count]; + for (NSUInteger i = 0; i < size; i++) { + NSString *clientPath = [_clients objectAtIndex: i]; + [self createMenuItemForIndex: i clientPath: clientPath]; + } +} + +- (void) awakeFromNib { + NSString *path = [[NSBundle mainBundle] resourcePath]; + _defaultClients = [[NSArray alloc] initWithObjects: + [path stringByAppendingPathComponent: @"weston-terminal"], + [path stringByAppendingPathComponent: @"weston-flower"], + [path stringByAppendingPathComponent: @"weston-smoke"], + nil + ]; + + [self update]; +} + +- (void) dealloc { + [_clientsMenu removeAllItems]; + [_defaultClients release]; + [_clients release]; + [super dealloc]; +} + +- (IBAction) startClient: (id) sender { + NSUInteger index = [sender tag]; + NSString *path = [_clients objectAtIndex: index]; + [NSTask launchedTaskWithLaunchPath: path arguments: [NSArray array]]; +} + +- (IBAction) configureClients: (id) sender { +} + +@end diff --git a/Sources/App/OwlPreferences.h b/Sources/App/OwlPreferences.h new file mode 100644 index 0000000..5465829 --- /dev/null +++ b/Sources/App/OwlPreferences.h @@ -0,0 +1,33 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> + + +@interface OwlPreferences : NSObject { + IBOutlet NSButton *_preferSSDButton; +} + ++ (OwlPreferences *) sharedPreferences; + +- (IBAction) openPreferencesWindow: (id) sender; +- (IBAction) takePreferSSD: (id) sender; + +- (BOOL) preferSSD; + +@end diff --git a/Sources/App/OwlPreferences.m b/Sources/App/OwlPreferences.m new file mode 100644 index 0000000..90440f3 --- /dev/null +++ b/Sources/App/OwlPreferences.m @@ -0,0 +1,49 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlPreferences.h" + + +@implementation OwlPreferences + +static OwlPreferences *shared; + +- (void) awakeFromNib { + shared = self; +} + ++ (OwlPreferences *) sharedPreferences { + return shared; +} + +- (IBAction) openPreferencesWindow: (id) sender { + [NSBundle loadNibNamed: @"OwlPreferences" owner: self]; + [_preferSSDButton setState: [self preferSSD]]; +} + +- (IBAction) takePreferSSD: (id) sender { + BOOL preferSSD = [sender state]; + [[NSUserDefaults standardUserDefaults] setBool: preferSSD + forKey: @"PreferSSD"]; +} + +- (BOOL) preferSSD { + return [[NSUserDefaults standardUserDefaults] boolForKey: @"PreferSSD"]; +} + +@end diff --git a/Sources/Compositor/OwlBuffer.h b/Sources/Compositor/OwlBuffer.h new file mode 100644 index 0000000..3ca0d78 --- /dev/null +++ b/Sources/Compositor/OwlBuffer.h @@ -0,0 +1,44 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlBuffer : NSObject { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; +- (id) initWithExternallyImplementedResource: (struct wl_resource *) resource; + ++ (OwlBuffer *) bufferForResource: (struct wl_resource *) resource; + +// Must be called after creating a buffer before calling any of the methods +// below, as well as each time the buffer contents are known to change. +- (void) invalidate; + +- (NSSize) size; + +- (BOOL) needsGLForRendering; +- (void) drawInRect: (NSRect) rect; + +- (void) sendRelease; +- (void) notifyDetached; + +@end diff --git a/Sources/Compositor/OwlBuffer.m b/Sources/Compositor/OwlBuffer.m new file mode 100644 index 0000000..fb0877e --- /dev/null +++ b/Sources/Compositor/OwlBuffer.m @@ -0,0 +1,114 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlBuffer.h" +#import "OwlShmBuffer.h" + + +@implementation OwlBuffer + +static NSMutableArray *buffers; + ++ (void) initialize { + if (buffers == nil) { + buffers = [NSMutableArray new]; + } +} + +static void buffer_destroy(struct wl_resource *resource) { + OwlBuffer *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void buffer_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static const struct wl_buffer_interface buffer_impl = { + .destroy = buffer_destroy_handler +}; + +- (id) initWithExternallyImplementedResource: (struct wl_resource *) resource { + _resource = resource; + [buffers addObject: self]; + return self; +} + +- (id) initWithResource: (struct wl_resource *) resource { + self = [self initWithExternallyImplementedResource: resource]; + wl_resource_set_implementation( + resource, + &buffer_impl, + [self retain], + buffer_destroy + ); + return self; +} + +- (void) dealloc { + [buffers removeObject: self]; + [super dealloc]; +} + ++ (OwlBuffer *) bufferForResource: (struct wl_resource *) resource { + if (resource == NULL) { + return nil; + } + // All buffer factories register their resources with us immediately on creation, + // except wl_shm, which is implemented outside of Owl (in wayland-server). + for (OwlBuffer *buffer in buffers) { + if (buffer->_resource == resource) { + return buffer; + } + } + return [[[OwlShmBuffer alloc] initWithResource: resource] autorelease]; +} + +- (void) invalidate { + // Do nothing, subclasses may override this to recompute their data. +} + +- (NSSize) size { + // Subclasses need to override this. + return NSZeroSize; +} + +- (BOOL) needsGLForRendering { + // Subclasses may override this if they need OpenGL. + return NO; +} + +- (void) drawInRect: (NSRect) rect { + // Do nothing, subclasses override this. +} + +- (void) sendRelease { + wl_buffer_send_release(_resource); +} + +- (void) notifyDetached { + // This method is invoked when the buffer is detached from a surface, + // The base implementation does nothing, subclasses may want to override + // it and call [self sendRelease] if they don't already call that at a + // different time. +} + +@end diff --git a/Sources/Compositor/OwlCompositor.h b/Sources/Compositor/OwlCompositor.h new file mode 100644 index 0000000..e648411 --- /dev/null +++ b/Sources/Compositor/OwlCompositor.h @@ -0,0 +1,29 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@interface OwlCompositor : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +@end diff --git a/Sources/Compositor/OwlCompositor.m b/Sources/Compositor/OwlCompositor.m new file mode 100644 index 0000000..e15feb3 --- /dev/null +++ b/Sources/Compositor/OwlCompositor.m @@ -0,0 +1,102 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlCompositor.h" +#import "OwlSurface.h" +#import "OwlRegion.h" +#import <Cocoa/Cocoa.h> + +@implementation OwlCompositor + +static void compositor_create_surface_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + uint32_t version = wl_resource_get_version(resource); + struct wl_resource *surface_resource = wl_resource_create( + client, + &wl_surface_interface, + version, + id + ); + [[[OwlSurface alloc] initWithResource: surface_resource] release]; +} + +static void compositor_create_region_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + uint32_t version = wl_resource_get_version(resource); + struct wl_resource *region_resource = wl_resource_create( + client, + &wl_region_interface, + version, + id + ); + [[[OwlRegion alloc] initWithResource: region_resource] release]; +} + +static const struct wl_compositor_interface compositor_interface = { + .create_surface = compositor_create_surface_handler, + .create_region = compositor_create_region_handler +}; + +static void compositor_destroy(struct wl_resource *resource) { + OwlCompositor *self = wl_resource_get_user_data(resource); + [self release]; +} + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &compositor_interface, + [self retain], + compositor_destroy + ); + return self; +} + +static void compositor_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &wl_compositor_interface, + version, + id + ); + [[[OwlCompositor alloc] initWithResource: resource] release]; +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create( + display, + &wl_compositor_interface, + 4, + NULL, + compositor_bind + ); +} + +@end diff --git a/Sources/Compositor/OwlIOSurfaceBuffer.h b/Sources/Compositor/OwlIOSurfaceBuffer.h new file mode 100644 index 0000000..741d26a --- /dev/null +++ b/Sources/Compositor/OwlIOSurfaceBuffer.h @@ -0,0 +1,37 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlFeatures.h" +#ifdef OWL_PLATFORM_APPLE + +#import "OwlBuffer.h" +#import <Cocoa/Cocoa.h> +#import <OpenGL/OpenGL.h> + + +@interface OwlIOSurfaceBuffer : OwlBuffer { + IOSurfaceRef _surface; + GLuint _tex; +} + +- (id) initWithResource: (struct wl_resource *) resource + surfacePort: (mach_port_t) surfacePort; + +@end + +#endif /* OWL_PLATFORM_APPLE */ diff --git a/Sources/Compositor/OwlIOSurfaceBuffer.m b/Sources/Compositor/OwlIOSurfaceBuffer.m new file mode 100644 index 0000000..eb25021 --- /dev/null +++ b/Sources/Compositor/OwlIOSurfaceBuffer.m @@ -0,0 +1,140 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlFeatures.h" +#ifdef OWL_PLATFORM_APPLE + +#import "OwlIOSurfaceBuffer.h" +#import <OpenGL/gl.h> +#import <OpenGL/CGLIOSurface.h> + + +@implementation OwlIOSurfaceBuffer + +- (id) initWithResource: (struct wl_resource *) resource + surfacePort: (mach_port_t) surfacePort +{ + self = [super initWithResource: resource]; + _surface = IOSurfaceLookupFromMachPort(surfacePort); + return self; +} + +- (void) dealloc { + IOSurfaceDecrementUseCount(_surface); + [super dealloc]; +} + +- (void) invalidate { + // ??? +} + +- (NSSize) size { + size_t width = IOSurfaceGetWidth(_surface); + size_t height = IOSurfaceGetHeight(_surface); + return NSMakeSize(width, height); +} + +- (BOOL) needsGLForRendering { + return YES; +} + +- (void) setupTextureWithCGLContext: (CGLContextObj) context { + glGenTextures(1, &_tex); + glBindTexture(GL_TEXTURE_RECTANGLE_ARB, _tex); + + size_t width = IOSurfaceGetWidth(_surface); + size_t height = IOSurfaceGetHeight(_surface); + + CGLTexImageIOSurface2D( + context, + GL_TEXTURE_RECTANGLE_ARB, // target + GL_RGBA, // internal_format + width, + height, + GL_BGRA, // format + GL_UNSIGNED_INT_8_8_8_8_REV, // type + _surface, + 0 // plane + ); + + glTexParameteri( + GL_TEXTURE_RECTANGLE_ARB, + GL_TEXTURE_MIN_FILTER, + GL_LINEAR + ); + glTexParameteri( + GL_TEXTURE_RECTANGLE_ARB, + GL_TEXTURE_MAG_FILTER, + GL_LINEAR + ); + glTexParameteri( + GL_TEXTURE_RECTANGLE_ARB, + GL_TEXTURE_WRAP_S, + GL_CLAMP_TO_EDGE + ); + glTexParameteri( + GL_TEXTURE_RECTANGLE_ARB, + GL_TEXTURE_WRAP_T, + GL_CLAMP_TO_EDGE + ); +} + +- (void) drawInRect: (NSRect) rect { + glViewport(0, 0, rect.size.width, rect.size.height); + glMatrixMode(GL_PROJECTION); + glLoadIdentity(); + glOrtho(0, rect.size.width, 0, rect.size.height, -1, 1); + + glMatrixMode(GL_MODELVIEW); + glLoadIdentity(); + + struct { + GLfloat x, y; + } coord[4] = { + {0, 0}, + {rect.size.width, 0}, + {0, rect.size.height}, + {rect.size.width, rect.size.height} + }; + + glEnable(GL_TEXTURE_RECTANGLE_ARB); + + NSOpenGLContext *currentContext = [NSOpenGLContext currentContext]; + [self setupTextureWithCGLContext: [currentContext CGLContextObj]]; + + glEnableClientState(GL_VERTEX_ARRAY); + glEnableClientState(GL_TEXTURE_COORD_ARRAY); + + glPushMatrix(); + glTexCoordPointer(2, GL_FLOAT, 0, coord); + glVertexPointer(2, GL_FLOAT, 0, coord); + + glDrawArrays(GL_TRIANGLE_STRIP, 0, 4); + + glPopMatrix(); + + glFlush(); +} + +- (void) notifyDetached { + [self sendRelease]; +} + +@end + +#endif /* OWL_PLATFORM_APPLE */ diff --git a/Sources/Compositor/OwlRegion.h b/Sources/Compositor/OwlRegion.h new file mode 100644 index 0000000..dbd07b3 --- /dev/null +++ b/Sources/Compositor/OwlRegion.h @@ -0,0 +1,29 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@interface OwlRegion : NSObject { + struct wl_resource *_resource; + // TODO +} + +- (id) initWithResource: (struct wl_resource *) resource; + +@end diff --git a/Sources/Compositor/OwlRegion.m b/Sources/Compositor/OwlRegion.m new file mode 100644 index 0000000..b64c974 --- /dev/null +++ b/Sources/Compositor/OwlRegion.m @@ -0,0 +1,76 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlRegion.h" +#import <wayland-server.h> + +@implementation OwlRegion + +static void region_destroy(struct wl_resource *resource) { + OwlRegion *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void region_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void region_add_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t x, + int32_t y, + int32_t width, + int32_t height +) { + // TODO +} + +static void region_subtract_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t x, + int32_t y, + int32_t width, + int32_t height +) { + // TODO +} + +static const struct wl_region_interface region_impl = { + .destroy = region_destroy_handler, + .add = region_add_handler, + .subtract = region_subtract_handler +}; + + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + ®ion_impl, + [self retain], + region_destroy + ); + return self; +} + +@end diff --git a/Sources/Compositor/OwlShmBuffer.h b/Sources/Compositor/OwlShmBuffer.h new file mode 100644 index 0000000..672da4e --- /dev/null +++ b/Sources/Compositor/OwlShmBuffer.h @@ -0,0 +1,35 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> +#import "OwlBuffer.h" +#import "OwlFeatures.h" + + +@interface OwlShmBuffer : OwlBuffer { + struct wl_shm_buffer *_buffer; + +#ifdef OWL_PLATFORM_APPLE + CGImageRef _image; +#else + NSBitmapImageRep *_rep; +#endif +} + +@end diff --git a/Sources/Compositor/OwlShmBuffer.m b/Sources/Compositor/OwlShmBuffer.m new file mode 100644 index 0000000..e984ef1 --- /dev/null +++ b/Sources/Compositor/OwlShmBuffer.m @@ -0,0 +1,186 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlShmBuffer.h" +#import "OwlFeatures.h" + + +@implementation OwlShmBuffer + +#ifdef OWL_PLATFORM_APPLE + +- (CGBitmapInfo) bitmapInfoForWlShmFormat: (enum wl_shm_format) shmFormat { + switch (shmFormat) { + case WL_SHM_FORMAT_XRGB8888: + return kCGImageAlphaNoneSkipFirst | kCGBitmapByteOrder32Little; + case WL_SHM_FORMAT_ARGB8888: + return kCGImageAlphaFirst | kCGBitmapByteOrder32Little; + default: + NSLog(@"Unknown shm format"); + return 0; + } +} + +static void dataReleaseCallback(void *info, const void *data, size_t size) { + free((void *) data); +} + +#endif /* OWL_PLATFORM_APPLE */ + +- (void) releaseImage { +#ifdef OWL_PLATFORM_APPLE + if (_image != NULL) { + CGImageRelease(_image); + _image = NULL; + } +#else + [_rep release]; + _rep = nil; +#endif +} + +- (void) invalidate { + [self releaseImage]; + + enum wl_shm_format format = wl_shm_buffer_get_format(_buffer); + size_t width = wl_shm_buffer_get_width(_buffer); + size_t height = wl_shm_buffer_get_height(_buffer); + size_t stride = wl_shm_buffer_get_stride(_buffer); + void *data = wl_shm_buffer_get_data(_buffer); + size_t size = height * stride; + +#ifdef OWL_PLATFORM_APPLE + CGBitmapInfo bitmapInfo = [self bitmapInfoForWlShmFormat: format]; + + CGColorSpaceRef colorSpace = CGColorSpaceCreateDeviceRGB(); + + void *dataCopy = malloc(size); + wl_shm_buffer_begin_access(_buffer); + memcpy(dataCopy, data, size); + wl_shm_buffer_end_access(_buffer); + [self sendRelease]; + + CGDataProviderRef provider = CGDataProviderCreateWithData( + NULL, + dataCopy, + size, + dataReleaseCallback + ); + _image = CGImageCreate( + width, + height, + 8, // bitsPerComponent + 32, // bitsPerPixel + stride, + colorSpace, + bitmapInfo, + provider, + NULL, // decode + YES, // shouldInterpolate + kCGRenderingIntentDefault + ); + CGDataProviderRelease(provider); + + CGColorSpaceRelease(colorSpace); +#else /* OWL_PLATFORM_APPLE */ + BOOL hasAlpha = format == WL_SHM_FORMAT_ARGB8888; + size_t samplesPerPixel = hasAlpha ? 4 : 3; + size_t destStride = samplesPerPixel * width; + + _rep = [NSBitmapImageRep alloc]; + _rep = [_rep initWithBitmapDataPlanes: NULL + pixelsWide: width + pixelsHigh: height + bitsPerSample: 8 + samplesPerPixel: samplesPerPixel + hasAlpha: hasAlpha + isPlanar: NO + colorSpaceName: NSCalibratedRGBColorSpace + bitmapFormat: 0 + bytesPerRow: destStride + bitsPerPixel: 8 * samplesPerPixel]; + + void *destData = [_rep bitmapData]; + wl_shm_buffer_begin_access(_buffer); + + struct bgra { + unsigned char b, g, r, a; + }; + struct rgba { + unsigned char r, g, b, a; + }; + + for (size_t row = 0; row < height; row++) { + for (size_t col = 0; col < width; col++) { + struct bgra *source = data + row * stride + col * 4; + struct rgba *dest = destData + row * destStride + col * samplesPerPixel; + dest->r = source->r; + dest->g = source->g; + dest->b = source->b; + if (hasAlpha) { + dest->a = source->a; + } + } + } + + wl_shm_buffer_end_access(_buffer); + [self sendRelease]; +#endif /* OWL_PLATFORM_APPLE */ +} + +- (id) initWithResource: (struct wl_resource *) resource { + self = [super initWithExternallyImplementedResource: resource]; + + _buffer = wl_shm_buffer_get(resource); + if (_buffer == NULL) { + [NSException raise: NSInternalInconsistencyException + format: @"wl_shm_buffer_get(wl_buffer@%u) == NULL", + wl_resource_get_id(resource)]; + return nil; + } + + return self; +} + +- (void) dealloc { + [self releaseImage]; + [super dealloc]; +} + +- (NSSize) size { + size_t width = wl_shm_buffer_get_width(_buffer); + size_t height = wl_shm_buffer_get_height(_buffer); + return NSMakeSize(width, height); +} + +- (void) drawInRect: (NSRect) rect { +#ifdef OWL_PLATFORM_APPLE + CGContextRef context = [[NSGraphicsContext currentContext] graphicsPort]; + CGContextSetBlendMode(context, kCGBlendModeCopy); + CGContextDrawImage(context, rect, _image); +#else + [_rep drawInRect: rect + fromRect: rect + operation: NSCompositeSourceOver + fraction: 1.0 + respectFlipped: NO + hints: nil]; +#endif +} + +@end diff --git a/Sources/Compositor/OwlSubcompositor.h b/Sources/Compositor/OwlSubcompositor.h new file mode 100644 index 0000000..51d6f05 --- /dev/null +++ b/Sources/Compositor/OwlSubcompositor.h @@ -0,0 +1,29 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@interface OwlSubcompositor : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +@end diff --git a/Sources/Compositor/OwlSubcompositor.m b/Sources/Compositor/OwlSubcompositor.m new file mode 100644 index 0000000..fd633d3 --- /dev/null +++ b/Sources/Compositor/OwlSubcompositor.m @@ -0,0 +1,113 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSubcompositor.h" +#import "OwlSurface.h" +#import "OwlSubsurface.h" + + +@implementation OwlSubcompositor + +static void subcompositor_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void subcompositor_destroy(struct wl_resource *resource) { + OwlSubcompositor *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void subcompositor_get_subsurface_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id, + struct wl_resource *surface_resource, + struct wl_resource *parent_resource +) { + struct wl_resource *subsurface_resource = wl_resource_create( + client, + &wl_subsurface_interface, + 1, + id + ); + OwlSurface *surface = wl_resource_get_user_data(surface_resource); + OwlSurface *parent = wl_resource_get_user_data(parent_resource); + +#if 0 + // FIXME: This line doesn't compile anymore on Hurd for some reason, WTF? + if ([surface role] != nil) { + const char *role = [[[surface role] description] UTF8String]; + wl_resource_post_error( + resource, + WL_SUBCOMPOSITOR_ERROR_BAD_SURFACE, + "Surface already has another role: %s", + role + ); + return; + } +#endif + [[[OwlSubsurface alloc] initWithResource: subsurface_resource + surface: surface + parent: parent] release]; +} + +static const struct wl_subcompositor_interface subcompositor_impl = { + .destroy = subcompositor_destroy_handler, + .get_subsurface = subcompositor_get_subsurface_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &subcompositor_impl, + [self retain], + subcompositor_destroy + ); + return self; +} + +static void subcompositor_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &wl_subcompositor_interface, + version, + id + ); + [[[OwlSubcompositor alloc] initWithResource: resource] release]; +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create( + display, + &wl_subcompositor_interface, + 1, + NULL, + subcompositor_bind + ); +} + +@end diff --git a/Sources/Compositor/OwlSubsurface.h b/Sources/Compositor/OwlSubsurface.h new file mode 100644 index 0000000..61253f0 --- /dev/null +++ b/Sources/Compositor/OwlSubsurface.h @@ -0,0 +1,35 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSurface.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@interface OwlSubsurface : NSObject<OwlSurfaceRole> { + struct wl_resource *_resource; + OwlSurface *_surface; + OwlSurface *_parent; + NSPoint _position; + BOOL _sync; +} + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface + parent: (OwlSurface *) parent; + +@end diff --git a/Sources/Compositor/OwlSubsurface.m b/Sources/Compositor/OwlSubsurface.m new file mode 100644 index 0000000..924c244 --- /dev/null +++ b/Sources/Compositor/OwlSubsurface.m @@ -0,0 +1,136 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSubsurface.h" +#import "OwlSurface.h" +#import "OwlServer.h" +#import <wayland-server.h> + +@implementation OwlSubsurface + +static void subsurface_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void subsurface_destroy(struct wl_resource *resource) { + OwlSubsurface *self = wl_resource_get_user_data(resource); + [self unmap]; + [self->_surface setRole: nil]; + [self release]; +} + +static void subsurface_set_position_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t x, + int32_t y +) { + OwlSubsurface *self = wl_resource_get_user_data(resource); + self->_position = NSMakePoint(x, y); +} + +static void subsurface_place_above_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *sibling_resource +) { + OwlSubsurface *self = wl_resource_get_user_data(resource); + // TODO +} + +static void subsurface_place_below_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *sibling_resource +) { + OwlSubsurface *self = wl_resource_get_user_data(resource); + // TODO +} + +static void subsurface_set_sync_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlSubsurface *self = wl_resource_get_user_data(resource); + // TODO +} + +static void subsurface_set_desync_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlSubsurface *self = wl_resource_get_user_data(resource); + // TODO +} + +static const struct wl_subsurface_interface subsurface_impl = { + .destroy = subsurface_destroy_handler, + .set_position = subsurface_set_position_handler, + .place_above = subsurface_place_above_handler, + .place_below = subsurface_place_below_handler, + .set_sync = subsurface_set_sync_handler, + .set_desync = subsurface_set_desync_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface + parent: (OwlSurface *) parent +{ + _resource = resource; + _surface = [surface retain]; + _parent = [parent retain]; + [surface setRole: self]; + + wl_resource_set_implementation( + resource, + &subsurface_impl, + [self retain], + subsurface_destroy + ); + + return self; +} + +- (void) dealloc { + [self unmap]; + [_surface release]; + [_parent release]; + [super dealloc]; +} + +// FIXME: These are supposed to be applied on parent's next commit. +- (void) map { + [_parent addSubview: _surface]; + [self update]; +} + +- (void) unmap { + [_surface removeFromSuperview]; +} + +- (void) update { + NSPoint origin; + origin.x = _position.x; + origin.y = [_parent frame].size.height - [_surface frame].size.height - _position.y; + [_surface setFrameOrigin: origin]; +} + +@end diff --git a/Sources/Compositor/OwlSurface.h b/Sources/Compositor/OwlSurface.h new file mode 100644 index 0000000..084e75b --- /dev/null +++ b/Sources/Compositor/OwlSurface.h @@ -0,0 +1,75 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@class OwlBuffer; +@class OwlSurfaceState; + +@protocol OwlSurfaceRole + +- (void) map; +- (void) unmap; +- (void) update; + +@end + +@interface OwlSurface : NSView { + struct wl_resource *_resource; + NSOpenGLContext *_openGLContext; + + // Mouse tracking rectangle. + NSTrackingRectTag _trackingRectTag; + // Sadly, we cannot trust Cocoa to always deliver us + // -mouseEntered: before -mouseMoved:, so keep our + // own track of whether we think the mouse is inside. + BOOL _mouseIsInside; + + // Callbacks to be sent when we draw a frame. + // These are first collected as a part of a pending + // state, and added to this array on a commit. Once + // added, the callbacks stay in this array no matter + // further state changes and commits, only to be sent + // out during the next -drawRect: call. + NSMutableArray *_callbacks; + + // The current state of this surface. This includes + // things such as the attached buffer and an array + // of damaged rects (compared to the previous frame). + OwlSurfaceState *_currentState; + // As the surface state in Wayland is double-buffered, + // we store the pending state separately while it is + // being built. This will become the new current state + // on the next commit. + OwlSurfaceState *_pendingState; + id<OwlSurfaceRole> _role; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +- (struct wl_resource *) resource; + +- (id<OwlSurfaceRole>) role; +- (void) setRole: (id<OwlSurfaceRole>) newRole; + +- (void) setPendingGeometry: (NSRect) geometry; + +- (NSSize) geometrySizeAdjustements; + +@end diff --git a/Sources/Compositor/OwlSurface.m b/Sources/Compositor/OwlSurface.m new file mode 100644 index 0000000..0774a05 --- /dev/null +++ b/Sources/Compositor/OwlSurface.m @@ -0,0 +1,437 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSurface.h" +#import "OwlCallback.h" +#import "OwlPointer.h" +#import "OwlKeyboard.h" +#import "OwlServer.h" +#import "OwlBuffer.h" +#import "OwlSurfaceState.h" +#import <wayland-server.h> +#import <Cocoa/Cocoa.h> + + +@implementation OwlSurface + +- (struct wl_resource *) resource { + return _resource; +} + +static void surface_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void surface_destroy(struct wl_resource *resource) { + OwlSurface *self = wl_resource_get_user_data(resource); + [self removeFromSuperview]; + [self release]; +} + +- (void) attachBuffer: (OwlBuffer *) buffer { + [_pendingState setBuffer: buffer]; + [buffer invalidate]; +} + +static void surface_attach_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *buffer_resource, + int32_t x, + int32_t y +) { + OwlSurface *self = wl_resource_get_user_data(resource); + OwlBuffer *buffer = [OwlBuffer bufferForResource: buffer_resource]; + [self attachBuffer: buffer]; +} + +static void surface_damage_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t x, + int32_t y, + int32_t width, + int32_t height +) { + OwlSurface *self = wl_resource_get_user_data(resource); + NSRect rect = NSMakeRect(x, y, width, height); + [self->_pendingState addDamage: rect]; +} + +- (void) setPendingGeometry: (NSRect) geometry { + [_pendingState setGeometry: geometry]; +} + +- (NSSize) geometrySizeAdjustements { + NSSize currentSize = [_currentState geometry].size; + if (currentSize.width == 0) { + return NSZeroSize; + } + + NSSize res; + + res.width = [self frame].size.width - currentSize.width; + res.height = [self frame].size.height - currentSize.height; + + return res; +} + +- (void) setUpGL { + NSOpenGLPixelFormatAttribute attrs[] = { 0 }; + NSOpenGLPixelFormat *format = [NSOpenGLPixelFormat alloc]; + format = [format initWithAttributes: attrs]; + _openGLContext = [[NSOpenGLContext alloc] initWithFormat: format + shareContext: nil]; + [format release]; +} + +- (void) tearDownGL { + [_openGLContext clearDrawable]; + [_openGLContext release]; + _openGLContext = nil; + [NSOpenGLContext clearCurrentContext]; +} + +- (void) updateTrackingRect { + if (_trackingRectTag != 0) { + [self removeTrackingRect: _trackingRectTag]; + } + _trackingRectTag = [self addTrackingRect: [self bounds] + owner: self + userData: NULL + assumeInside: NO]; +} + +- (void) commit { + OwlBuffer *oldBuffer = [_currentState buffer]; + OwlBuffer *newBuffer = [_pendingState buffer]; + BOOL oldBufferNeedsGL = [oldBuffer needsGLForRendering]; + BOOL newBufferNeedsGL = [newBuffer needsGLForRendering]; + + // We're going to "map" the surface if it wasn't + // mapped previously and the new buffer is not nil. + BOOL map = oldBuffer == nil && newBuffer != nil; + // Conversely, we're going to unmap it if the new + // buffer is actually nil. We're going to call + // [role unmap] even if wasn't mapped; the roles + // are expected to deal with it by e.g. sending + // some sort of a configure event. + BOOL unmap = newBuffer == nil; + + BOOL setUpGL = !oldBufferNeedsGL && newBufferNeedsGL; + BOOL tearDownGL = oldBufferNeedsGL && !newBufferNeedsGL; + BOOL damageAll = oldBufferNeedsGL != newBufferNeedsGL; + + if (setUpGL) { + [self setUpGL]; + } + + if (oldBuffer != newBuffer) { + [oldBuffer notifyDetached]; + } + + // Actually set the pending state as our new state. + [_currentState release]; + _currentState = _pendingState; + _pendingState = [OwlSurfaceState alloc]; + _pendingState = [_pendingState initWithPreviousState: _currentState]; + + [_callbacks addObjectsFromArray: [_currentState callbacks]]; + + if (tearDownGL) { + [self tearDownGL]; + } + + if (unmap) { + [_role unmap]; + // Nothing further to do, as we have no buffer. + return; + } + + if (!NSEqualSizes([self frame].size, [newBuffer size])) { + [self setFrameSize: [newBuffer size]]; + [self updateTrackingRect]; + } + + if (map) { + [_role map]; + } else { + [_role update]; + } + + // Now, tell Cocoa to redraw this view. + if (damageAll) { + [self setNeedsDisplay: YES]; + } else { + for (NSValue *value in [_currentState damage]) { + NSRect rect = [value rectValue]; + rect.origin.y = [newBuffer size].height - rect.size.height - rect.origin.y; + [self setNeedsDisplayInRect: rect]; + } + } +} + +static void surface_commit_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlSurface *self = wl_resource_get_user_data(resource); + [self commit]; +} + +- (void) drawRect: (NSRect) dirtyRect { + // Ensure the GL context is set up correctly. + // This has no effect if we're not using GL. + [_openGLContext setView: self]; + [_openGLContext makeCurrentContext]; + + [[_currentState buffer] drawInRect: [self bounds]]; + + // We have painted; so send out all callbacks. + uint32_t timestamp = [OwlServer timestamp]; + for (OwlCallback *callback in _callbacks) { + [callback sendDoneWithData: timestamp]; + } + [_callbacks removeAllObjects]; + + [[self window] invalidateShadow]; + + [[OwlServer sharedServer] flushClientsLater]; +} + +static void surface_set_opaque_region_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *region_resource +) { + // TODO +} + +static void surface_set_input_region_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *region_resource +) { + // TODO +} + +static void surface_set_buffer_scale_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t scale +) { + // TODO +} + +static void surface_set_buffer_transform_handler( + struct wl_client *client, + struct wl_resource *resource, + /* enum wl_output_transform */ int32_t transform +) { + // TODO +} + +static void surface_frame_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + OwlSurface *self = wl_resource_get_user_data(resource); + struct wl_resource *callback_resource = wl_resource_create( + client, + &wl_callback_interface, + 1, + id + ); + OwlCallback *callback = [[OwlCallback alloc] initWithResource: callback_resource]; + [self->_pendingState addCallback: callback]; + [callback release]; +} + +static const struct wl_surface_interface surface_interface = { + .destroy = surface_destroy_handler, + .attach = surface_attach_handler, + .damage = surface_damage_handler, + .commit = surface_commit_handler, + .frame = surface_frame_handler, + .set_opaque_region = surface_set_opaque_region_handler, + .set_input_region = surface_set_input_region_handler, + .set_buffer_scale = surface_set_buffer_scale_handler, + .set_buffer_transform = surface_set_buffer_transform_handler + // TODO +}; + +- (id) initWithResource: (struct wl_resource *) resource { + self = [super initWithFrame: NSZeroRect]; + _resource = resource; + wl_resource_set_implementation( + resource, + &surface_interface, + [self retain], + surface_destroy + ); + _callbacks = [NSMutableArray new]; + _currentState = [OwlSurfaceState new]; + _pendingState = [OwlSurfaceState new]; + return self; +} + +- (void) dealloc { + [self tearDownGL]; + [_callbacks release]; + [_currentState release]; + [_pendingState release]; + [super dealloc]; +} + +- (id<OwlSurfaceRole>) role { + return _role; +} + +- (void) setRole: (id<OwlSurfaceRole>) newRole { + _role = newRole; +} + +- (OwlPointer *) pointer { + struct wl_client *client = wl_resource_get_client(_resource); + return [OwlPointer pointerForClient: client]; +} + +- (OwlKeyboard *) keyboard { + struct wl_client *client = wl_resource_get_client(_resource); + return [OwlKeyboard keyboardForClient: client]; +} + +- (NSPoint) pointOfEvent: (NSEvent *) event { + NSPoint point = [event locationInWindow]; + point = [self convertPoint: point fromView: nil]; + point.y = [self bounds].size.height - point.y; + return point; +} + +- (void) mouseEntered: (NSEvent *) event { + [[self window] setAcceptsMouseMovedEvents: YES]; + NSPoint point = [self pointOfEvent: event]; + if (!_mouseIsInside) { + [[self pointer] sendEnterSurface: self atPoint: point]; + _mouseIsInside = YES; + } else { + // We believe the mouse to already be inside, and now + // we get an enter event again. No need to send an enter + // event to our client, but we do need to send the new + // position, so fake a move event. + [[self pointer] sendMotionAtPoint: point]; + } + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) ensureMouseIsInside: (NSEvent *) event { + if (!_mouseIsInside) { + // We haven't been told the mouse is inside our view, + // but apparently it is. Fake an enter event. + [self mouseEntered: event]; + } +} + +- (void) mouseMoved: (NSEvent *) event { + NSPoint point = [self pointOfEvent: event]; + // See whether the mouse is really inside our view. + // If it's outside our view, stop receiving mouse events. + if (!NSPointInRect(point, [self bounds])) { + [[self window] setAcceptsMouseMovedEvents: NO]; + return; + } + + [self ensureMouseIsInside: event]; + [[self pointer] sendMotionAtPoint: point]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) mouseDragged: (NSEvent *) event { + [self mouseMoved: event]; +} + +- (void) mouseExited: (NSEvent *) event { + _mouseIsInside = NO; + [[self window] setAcceptsMouseMovedEvents: NO]; + [[self pointer] sendLeaveSurface: self]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) mouseDown: (NSEvent *) event { + [self ensureMouseIsInside: event]; + [[self pointer] sendButton: BTN_LEFT isPressed: YES]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) mouseUp: (NSEvent *) event { + [self ensureMouseIsInside: event]; + [[self pointer] sendButton: BTN_LEFT isPressed: NO]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) rightMouseDown: (NSEvent *) event { + [self ensureMouseIsInside: event]; + [[self pointer] sendButton: BTN_RIGHT isPressed: YES]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) rightMouseUp: (NSEvent *) event { + [self ensureMouseIsInside: event]; + [[self pointer] sendButton: BTN_RIGHT isPressed: NO]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) rightMouseDragged: (NSEvent *) event { + [self mouseMoved: event]; +} + +- (void) scrollWheel: (NSEvent *) event { + [self ensureMouseIsInside: event]; + [[self pointer] sendScrollByX: [event deltaX] byY: [event deltaY]]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (BOOL) acceptsFirstResponder { + return YES; +} + +- (void) keyDown: (NSEvent *) event { + [[self keyboard] sendKey: [event keyCode] isPressed: YES]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) keyUp: (NSEvent *) event { + [[self keyboard] sendKey: [event keyCode] isPressed: NO]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) flagsChanged: (NSEvent *) event { + NSUInteger flags = [event modifierFlags]; + BOOL shift = (flags & NSShiftKeyMask) ? YES : NO; + BOOL ctrl = (flags & NSCommandKeyMask) ? YES : NO; + BOOL alt = (flags & NSAlternateKeyMask) ? YES : NO; + uint32_t mods = shift + ctrl * 4 + alt * 262152; + [[self keyboard] sendModifiers: mods]; + [[OwlServer sharedServer] flushClientsLater]; +} + +@end diff --git a/Sources/Compositor/OwlSurfaceState.h b/Sources/Compositor/OwlSurfaceState.h new file mode 100644 index 0000000..505b28d --- /dev/null +++ b/Sources/Compositor/OwlSurfaceState.h @@ -0,0 +1,47 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> + +@class OwlBuffer; +@class OwlCallback; + +@interface OwlSurfaceState : NSObject { + OwlBuffer *_buffer; + // TODO: dx, dy + NSMutableArray *_callbacks; + NSMutableArray *_damage; + NSRect _geometry; +} + +- (id) init; +- (id) initWithPreviousState: (OwlSurfaceState *) previousState; + +- (OwlBuffer *) buffer; +- (void) setBuffer: (OwlBuffer *) buffer; + +- (NSArray *) callbacks; +- (void) addCallback: (OwlCallback *) callback; + +- (NSArray *) damage; +- (void) addDamage: (NSRect) damageRect; + +- (NSRect) geometry; +- (void) setGeometry: (NSRect) geometry; + +@end diff --git a/Sources/Compositor/OwlSurfaceState.m b/Sources/Compositor/OwlSurfaceState.m new file mode 100644 index 0000000..1e98daa --- /dev/null +++ b/Sources/Compositor/OwlSurfaceState.m @@ -0,0 +1,85 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSurfaceState.h" +#import "OwlBuffer.h" + + +@implementation OwlSurfaceState + +- (id) init { + _callbacks = [NSMutableArray new]; + _damage = [NSMutableArray new]; + return self; +} + +// Make a new state to succeed the given previous state. +// +// This copies over parts of the previous state that should +// be copied over, namely the attached buffer and geometry, +// and initializes other state to empty values. +- (id) initWithPreviousState: (OwlSurfaceState *) previousState { + self = [self init]; + _buffer = [previousState->_buffer retain]; + _geometry = previousState->_geometry; + return self; +} + +- (void) dealloc { + [_buffer release]; + [_callbacks release]; + [_damage release]; + [super dealloc]; +} + +- (OwlBuffer *) buffer { + return _buffer; +} + +- (void) setBuffer: (OwlBuffer *) buffer { + [buffer retain]; + [_buffer release]; + _buffer = buffer; +} + +- (NSArray *) callbacks { + return _callbacks; +} + +- (void) addCallback: (OwlCallback *) callback { + [_callbacks addObject: callback]; +} + +- (NSArray *) damage { + return _damage; +} + +- (void) addDamage: (NSRect) damageRect { + NSValue *value = [NSValue valueWithRect: damageRect]; + [_damage addObject: value]; +} + +- (NSRect) geometry { + return _geometry; +} + +- (void) setGeometry: (NSRect) geometry { + _geometry = geometry; +} + +@end diff --git a/Sources/Compositor/OwlZowlIOSurfaceManagerV1.h b/Sources/Compositor/OwlZowlIOSurfaceManagerV1.h new file mode 100644 index 0000000..0270931 --- /dev/null +++ b/Sources/Compositor/OwlZowlIOSurfaceManagerV1.h @@ -0,0 +1,33 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlFeatures.h" +#ifdef OWL_PLATFORM_APPLE + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlZowlIOSurfaceManagerV1 : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + +@end + +#endif /* OWL_PLATFORM_APPLE */ diff --git a/Sources/Compositor/OwlZowlIOSurfaceManagerV1.m b/Sources/Compositor/OwlZowlIOSurfaceManagerV1.m new file mode 100644 index 0000000..1976054 --- /dev/null +++ b/Sources/Compositor/OwlZowlIOSurfaceManagerV1.m @@ -0,0 +1,105 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlFeatures.h" +#ifdef OWL_PLATFORM_APPLE + +#import "OwlZowlIOSurfaceManagerV1.h" +#import "OwlZowlIOSurfaceV1.h" +#import <wayland-server.h> +#import "OwlGlobal.h" +#import "owl-iosurface-unstable-v1.h" +#import "OwlZowlMachIpcPortV1.h" + + +@implementation OwlZowlIOSurfaceManagerV1 + +static void iosurface_manager_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void iosurface_manager_create_surface_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *port_resource, + uint32_t id +) { + struct wl_resource *iosurface_resource = wl_resource_create( + client, + &zowl_iosurface_v1_interface, + 1, + id + ); + OwlZowlIOSurfaceV1 *iosurface = [[OwlZowlIOSurfaceV1 alloc] initWithResource: iosurface_resource]; + OwlZowlMachIpcPortV1 *port = wl_resource_get_user_data(port_resource); + [port setPort: [iosurface receiverPort]]; + [iosurface release]; +} + +static const struct zowl_iosurface_manager_v1_interface iosurface_manager_impl = { + .create_surface = iosurface_manager_create_surface_handler, + .destroy = iosurface_manager_destroy_handler +}; + +static void iosurface_manager_destroy(struct wl_resource *resource) { + OwlZowlIOSurfaceManagerV1 *self = wl_resource_get_user_data(resource); + [self release]; +} + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &iosurface_manager_impl, + [self retain], + iosurface_manager_destroy + ); + return self; +} + +static void iosurface_manager_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &zowl_iosurface_manager_v1_interface, + version, + id + ); + [[[OwlZowlIOSurfaceManagerV1 alloc] initWithResource: resource] release]; +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create( + display, + &zowl_iosurface_manager_v1_interface, + 1, + NULL, + iosurface_manager_bind + ); +} + +@end + +#endif /* OWL_PLATFORM_APPLE */ diff --git a/Sources/Compositor/OwlZowlIOSurfaceV1.h b/Sources/Compositor/OwlZowlIOSurfaceV1.h new file mode 100644 index 0000000..1ea96c5 --- /dev/null +++ b/Sources/Compositor/OwlZowlIOSurfaceV1.h @@ -0,0 +1,39 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlFeatures.h" +#ifdef OWL_PLATFORM_APPLE + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> +#import <mach/mach.h> + + +@interface OwlZowlIOSurfaceV1 : NSObject { + struct wl_resource *_resource; + mach_port_t _receiverPort; + mach_port_t _surfacePort; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +- (mach_port_t) receiverPort; + +@end + +#endif /* OWL_PLATFORM_APPLE */ diff --git a/Sources/Compositor/OwlZowlIOSurfaceV1.m b/Sources/Compositor/OwlZowlIOSurfaceV1.m new file mode 100644 index 0000000..9b9a022 --- /dev/null +++ b/Sources/Compositor/OwlZowlIOSurfaceV1.m @@ -0,0 +1,131 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlFeatures.h" +#ifdef OWL_PLATFORM_APPLE + +#import "OwlZowlIOSurfaceV1.h" +#import "owl-iosurface-unstable-v1.h" +#import "owl-iosurface-unstable-v1-mig.h" +#import "OwlMIG.h" +#import "OwlIOSurfaceBuffer.h" + +@implementation OwlZowlIOSurfaceV1 + +static NSMutableArray *instances; + ++ (void) initialize { + if (instances == nil) { + instances = [[NSMutableArray alloc] init]; + } +} + +static void iosurface_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void iosurface_destroy(struct wl_resource *resource) { + OwlZowlIOSurfaceV1 *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void iosurface_create_buffer_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + OwlZowlIOSurfaceV1 *self = wl_resource_get_user_data(resource); + struct wl_resource *buffer_resource = wl_resource_create( + client, + &wl_buffer_interface, + 1, + id + ); + [[[OwlIOSurfaceBuffer alloc] initWithResource: buffer_resource + surfacePort: self->_surfacePort] release]; +} + +static const struct zowl_iosurface_v1_interface iosurface_impl = { + .create_buffer = iosurface_create_buffer_handler, + .destroy = iosurface_destroy_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource { + [instances addObject: self]; + _resource = resource; + wl_resource_set_implementation( + resource, + &iosurface_impl, + [self retain], + iosurface_destroy + ); + + // Create the receiver port and serve owl_iosurface_v1 on it. + mach_port_allocate( + mach_task_self(), + MACH_PORT_RIGHT_RECEIVE, + &_receiverPort + ); + [OwlMIG serveOnPort: _receiverPort + usingCallback: owl_iosurface_v1_server + maxSize: 100]; + + return self; +} + +- (void) dealloc { + mach_port_deallocate(mach_task_self(), _receiverPort); + if (MACH_PORT_VALID (_surfacePort)) { + mach_port_deallocate(mach_task_self(), _surfacePort); + } + [instances removeObject: self]; + [super dealloc]; +} + +- (mach_port_t) receiverPort { + return _receiverPort; +} + ++ (OwlZowlIOSurfaceV1 *) surfaceByReceiverPort: (mach_port_t) port { + for (OwlZowlIOSurfaceV1 *surface in instances) { + if (surface->_receiverPort == port) { + return surface; + } + } + return nil; +} + +kern_return_t owl_iosurface_v1_server_set_surface_port( + mach_port_t receiver_port, + mach_port_t iosurface_port +) { + OwlZowlIOSurfaceV1 *surface = [OwlZowlIOSurfaceV1 surfaceByReceiverPort: receiver_port]; + if (surface == nil) { + NSLog(@"Failed to find the surface the receiver port belongs to"); + return KERN_INVALID_ARGUMENT; + } + surface->_surfacePort = iosurface_port; + return KERN_SUCCESS; +} + +@end + +#endif /* OWL_PLATFORM_APPLE */ diff --git a/Sources/Data/OwlDataDevice.h b/Sources/Data/OwlDataDevice.h new file mode 100644 index 0000000..0dfb371 --- /dev/null +++ b/Sources/Data/OwlDataDevice.h @@ -0,0 +1,33 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@class OwlSelection; + + +@interface OwlDataDevice : NSObject { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +- (void) selectionChanged: (OwlSelection *) selection; + +@end diff --git a/Sources/Data/OwlDataDevice.m b/Sources/Data/OwlDataDevice.m new file mode 100644 index 0000000..fc41fbd --- /dev/null +++ b/Sources/Data/OwlDataDevice.m @@ -0,0 +1,32 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataDevice.h" +#import "OwlDataSource.h" +#import "OwlSelection.h" +#import <wayland-server.h> + + +@implementation OwlDataDevice + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + return self; +} + +@end diff --git a/Sources/Data/OwlDataOffer.h b/Sources/Data/OwlDataOffer.h new file mode 100644 index 0000000..63a84c0 --- /dev/null +++ b/Sources/Data/OwlDataOffer.h @@ -0,0 +1,47 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataSource.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +// Data offers are sent to clients to represent a data source that they +// can request data from. There can be multiple data offers representing +// one data source (typically, one per data device). +// +// A data offer and the data source it represents need not use the same +// protocol: a client can ask to recevive data from a data offer using +// one protocol, and Owl will ask the backing client to send the data for +// the data source using another one. +@interface OwlDataOffer : NSObject <OwlDataSourceHolder> { + struct wl_resource *_resource; + OwlDataSource *_dataSource; +} + +- (id) initWithResource: (struct wl_resource *) resource + dataSource: (OwlDataSource *) dataSource; + +- (struct wl_resource *) resource; + +- (void) receiveContentOfMimeType: (const char *) mime_type + intoFileDescriptor: (int) fd; + +// Subclasses should override this. +- (void) addMimeType: (NSString *) mimeType; + +@end diff --git a/Sources/Data/OwlDataOffer.m b/Sources/Data/OwlDataOffer.m new file mode 100644 index 0000000..e07ec2e --- /dev/null +++ b/Sources/Data/OwlDataOffer.m @@ -0,0 +1,66 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataOffer.h" +#import "OwlDataSource.h" +#import <wayland-server.h> + + +@implementation OwlDataOffer + +- (id) initWithResource: (struct wl_resource *) resource + dataSource: (OwlDataSource *) source +{ + _resource = resource; + _dataSource = [source retain]; + [source addHolder: self]; + for (NSString *mimeType in [source mimeTypes]) { + [self addMimeType: mimeType]; + } + return self; +} + +- (struct wl_resource *) resource { + return _resource; +} + +- (void) dealloc { + [_dataSource removeHolder: self]; + [_dataSource release]; + [super dealloc]; +} + +- (void) receiveContentOfMimeType: (const char *) mime_type + intoFileDescriptor: (int) fd +{ + NSFileHandle *fileHandle = [[NSFileHandle alloc] initWithFileDescriptor: fd]; + NSString *mimeType = [NSString stringWithUTF8String: mime_type]; + + [_dataSource sendContentOfMimeType: mimeType toFileHandle: fileHandle]; + + // Make sure not to delay closing the file. + [fileHandle closeFile]; + [fileHandle release]; +} + +- (void) releaseDataSource: (OwlDataSource *) source { + [_dataSource release]; + _dataSource = nil; +} + +@end diff --git a/Sources/Data/OwlDataSource.h b/Sources/Data/OwlDataSource.h new file mode 100644 index 0000000..a9236b7 --- /dev/null +++ b/Sources/Data/OwlDataSource.h @@ -0,0 +1,65 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@class OwlDataSource; + +// Something that keeps a reference to a data source. +// +// A data source can conceptually die at any moment, but the object +// can only be deallocated once all the references to it are gone. +// To make this work, data sources notify the interested parties of their +// death, asking them to drop their reference. Once they all do, the data +// source gets deallocated. +// +// In addition to implementing -releaseDataSource:, data source holders +// should call -addHolder: and -removeHolder: as appropriate, to help the +// data source maintain an up-to-date list of its holders. +@protocol OwlDataSourceHolder +- (void) releaseDataSource: (OwlDataSource *) source; +@end + + +// A data source represents a lazily-received piece of data, perhaps +// available in several formats, such as plain and rich text. +// +// Typically, it's a client that actually has the data represented by a +// data source. +@interface OwlDataSource : NSObject { + struct wl_resource *_resource; + NSMutableArray *_mimeTypes; + NSMutableArray *_holders; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +- (NSArray *) mimeTypes; + +// Data source holder management. +- (void) addHolder: (id<OwlDataSourceHolder>) holder; +- (void) removeHolder: (id<OwlDataSourceHolder>) holder; +- (void) releaseFromHolders; + +// Subclasses should override these. +- (void) sendContentOfMimeType: (NSString *) mimeType + toFileHandle: (NSFileHandle *) fileHandle; +- (void) sendCancelled; + +@end diff --git a/Sources/Data/OwlDataSource.m b/Sources/Data/OwlDataSource.m new file mode 100644 index 0000000..e871a92 --- /dev/null +++ b/Sources/Data/OwlDataSource.m @@ -0,0 +1,60 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataSource.h" + + +@implementation OwlDataSource + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + _mimeTypes = [NSMutableArray new]; + _holders = [NSMutableArray new]; + return self; +} + +- (void) dealloc { + [_mimeTypes release]; + [_holders release]; + [super dealloc]; +} + +- (NSArray *) mimeTypes { + return _mimeTypes; +} + +- (void) addHolder: (id<OwlDataSourceHolder>) holder { + NSValue *value = [NSValue valueWithNonretainedObject: holder]; + [_holders addObject: value]; +} + +- (void) removeHolder: (id<OwlDataSourceHolder>) holder { + NSValue *value = [NSValue valueWithNonretainedObject: holder]; + [_holders removeObject: value]; +} + +// Ask all holders to release their references to this data source. +- (void) releaseFromHolders { + for (NSValue *value in _holders) { + id<OwlDataSourceHolder> holder = [value nonretainedObjectValue]; + [holder releaseDataSource: self]; + } + [_holders removeAllObjects]; +} + +@end diff --git a/Sources/Data/OwlPasteboardDataDevice.h b/Sources/Data/OwlPasteboardDataDevice.h new file mode 100644 index 0000000..1540539 --- /dev/null +++ b/Sources/Data/OwlPasteboardDataDevice.h @@ -0,0 +1,41 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataDevice.h" +#import <Cocoa/Cocoa.h> + +@class OwlSelection; +@class OwlPasteboardDataOffer; + +// Data device that is backed by a pasteboard, not a Wayland client. +@interface OwlPasteboardDataDevice : OwlDataDevice { + NSPasteboard *_pasteboard; + OwlSelection *_selection; + OwlPasteboardDataOffer *_currentOffer; + BOOL _ignoreRefreshes; +} + +- (id) initWithPasteboard: (NSPasteboard *) pasteboard + selection: (OwlSelection *) selection; + +- (NSPasteboard *) pasteboard; + +// Notify this data device that the pasteboard may have been refreshed. +- (void) pasteboardRefreshed; + +@end diff --git a/Sources/Data/OwlPasteboardDataDevice.m b/Sources/Data/OwlPasteboardDataDevice.m new file mode 100644 index 0000000..7a514ea --- /dev/null +++ b/Sources/Data/OwlPasteboardDataDevice.m @@ -0,0 +1,106 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlPasteboardDataDevice.h" +#import "OwlPasteboardDataOffer.h" +#import "OwlPasteboardDataSource.h" +#import "OwlServer.h" +#import "OwlSelection.h" + + +@implementation OwlPasteboardDataDevice + +// Publish a fresh data source representing our pasteboard +// as the selection content. +- (void) publishDataSource { + OwlPasteboardDataSource *dataSource = [OwlPasteboardDataSource alloc]; + dataSource = [dataSource initWithPasteboard: _pasteboard]; + + [_selection setDataSource: dataSource]; + [dataSource release]; + [[OwlServer sharedServer] flushClientsLater]; +} + +// FIXME: This is only called by our own offers when they get cancelled, +// which means we miss refreshes when we don't own the pasteboard. +- (void) pasteboardRefreshed { + if (_ignoreRefreshes) { + return; + } + // We have to do this asynchronously, otherwise NSPasteboard gets confused over + // accessing pasteboard contents from the pasteboardChangedOwner handler, and + // sends the same notification again and again, recursively. + // The order argument below represents which order these delayed selectors should + // be executed in; lower values go first. We do not care, so pass some large number. + NSArray *modes = [NSArray arrayWithObject: NSDefaultRunLoopMode]; + [[NSRunLoop currentRunLoop] performSelector: @selector(publishDataSource) + target: self + argument: nil + order: 1000 + modes: modes]; +} + +- (id) initWithPasteboard: (NSPasteboard *) pboard + selection: (OwlSelection *) selection +{ + self = [super initWithResource: NULL]; + _pasteboard = [pboard retain]; + _selection = [selection retain]; + [selection addDataDevice: self]; + // On startup, initialize selection with pasteboard contents. + // We assume no clients have connected yet. + [self pasteboardRefreshed]; + return self; +} + +- (void) dealloc { + [_pasteboard release]; + [_selection removeDataDevice: self]; + [_selection release]; + [_currentOffer release]; + [super dealloc]; +} + +- (NSPasteboard *) pasteboard { + return _pasteboard; +} + +// Selection has changed; proxy the new contents to the pasteboard. +- (void) selectionChanged: (OwlSelection *) selection { + OwlDataSource *dataSource = [selection dataSource]; + [_currentOffer release]; + _currentOffer = nil; + + if (dataSource == nil) { + [_pasteboard clearContents]; + return; + } + + // Don't proxy pasteboard contents back to the pasteboard. + if ([dataSource isKindOfClass: [OwlPasteboardDataSource class]]) { + return; + } + + _ignoreRefreshes = YES; + _currentOffer = [OwlPasteboardDataOffer alloc]; + _currentOffer = [_currentOffer initWithDataDevice: self + dataSource: dataSource]; + _ignoreRefreshes = NO; +} + +@end diff --git a/Sources/Data/OwlPasteboardDataOffer.h b/Sources/Data/OwlPasteboardDataOffer.h new file mode 100644 index 0000000..d1a96a4 --- /dev/null +++ b/Sources/Data/OwlPasteboardDataOffer.h @@ -0,0 +1,36 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataOffer.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@class OwlPasteboardDataDevice; +@class OwlDataSource; + +// Data offer to a pasteboard. Serves both as an Owl data offer +// and as a pasteboard "owner". +@interface OwlPasteboardDataOffer : OwlDataOffer { + NSMutableArray *_types; + OwlPasteboardDataDevice *_dataDevice; +} + +- (id) initWithDataDevice: (OwlPasteboardDataDevice *) device + dataSource: (OwlDataSource *) source; + +@end diff --git a/Sources/Data/OwlPasteboardDataOffer.m b/Sources/Data/OwlPasteboardDataOffer.m new file mode 100644 index 0000000..e6b9180 --- /dev/null +++ b/Sources/Data/OwlPasteboardDataOffer.m @@ -0,0 +1,88 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlPasteboardDataOffer.h" +#import "OwlDataOffer.h" +#import "OwlPasteboardDataDevice.h" +#import "OwlPasteboardType.h" +#import "OwlServer.h" +#import "OwlDataDevice.h" +#import "OwlSelection.h" +#import <wayland-server.h> + + +@implementation OwlPasteboardDataOffer + +- (id) initWithDataDevice: (OwlPasteboardDataDevice *) device + dataSource: (OwlDataSource *) dataSource +{ + _types = [NSMutableArray new]; + _dataDevice = [device retain]; + // The parent constructor fills in types. + [super initWithResource: NULL dataSource: dataSource]; + [[device pasteboard] declareTypes: _types owner: self]; + return self; +} + +- (void) dealloc { + [_types release]; + [_dataDevice release]; + [super dealloc]; +} + +- (void) addMimeType: (NSString *) mimeType { + OwlPasteboardType *type = [[OwlPasteboardType alloc] initWithMimeType: mimeType]; + [_types addObject: [type UTI]]; + [type release]; +} + +- (void) pasteboard: (NSPasteboard *) pasteboard + provideDataForType: (NSString *) uti +{ + OwlPasteboardType *type = [[[OwlPasteboardType alloc] initWithUTI: uti] autorelease]; + NSString *mimeType = [type mimeType]; + if (mimeType == nil) { + // We can't meaningfully convert this UTI to a MIME type. + // Refuse to provide the data, and hope for the better. + return; + } + + NSPipe *pipe = [NSPipe pipe]; + NSFileHandle *writingHandle = [pipe fileHandleForWriting]; + [_dataSource sendContentOfMimeType: mimeType + toFileHandle: writingHandle]; + [writingHandle closeFile]; + [[OwlServer sharedServer] flushClients]; + + // Sigh, it seems there's no other way but to do this synchronously. + NSData *data = [[pipe fileHandleForReading] readDataToEndOfFile]; + if ([type isText]) { + NSString *s = [[NSString alloc] initWithData: data + encoding: NSUTF8StringEncoding]; + [pasteboard setString: s forType: uti]; + [s release]; + } else { + [pasteboard setData: data forType: uti]; + } +} + +- (void) pasteboardChangedOwner: (NSPasteboard *) pasteboard { + [_dataDevice pasteboardRefreshed]; +} + +@end diff --git a/Sources/Data/OwlPasteboardDataSource.h b/Sources/Data/OwlPasteboardDataSource.h new file mode 100644 index 0000000..eb863a6 --- /dev/null +++ b/Sources/Data/OwlPasteboardDataSource.h @@ -0,0 +1,29 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataSource.h" +#import <Cocoa/Cocoa.h> + +// A data source that is backed by pasteboard contents. +@interface OwlPasteboardDataSource : OwlDataSource { + NSPasteboard *_pasteboard; +} + +- (id) initWithPasteboard: (NSPasteboard *) pasteboard; + +@end diff --git a/Sources/Data/OwlPasteboardDataSource.m b/Sources/Data/OwlPasteboardDataSource.m new file mode 100644 index 0000000..ccd4659 --- /dev/null +++ b/Sources/Data/OwlPasteboardDataSource.m @@ -0,0 +1,72 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlPasteboardDataSource.h" +#import "OwlPasteboardType.h" +#import <Cocoa/Cocoa.h> + + +@implementation OwlPasteboardDataSource + +- (id) initWithPasteboard: (NSPasteboard *) pboard { + self = [super initWithResource: NULL]; + _pasteboard = [pboard retain]; + + // Make a copy of the types array first. + // Otherwise we run into a crash on GNUstep + // while trying to use NSFastEnumeration + // with distributed objects. + NSArray *types = [NSArray arrayWithArray: [pboard types]]; + for (NSString *uti in types) { + OwlPasteboardType *type = [[OwlPasteboardType alloc] initWithUTI: uti]; + NSString *mimeType = [type mimeType]; + if (mimeType != nil) { + [_mimeTypes addObject: mimeType]; + } + [type release]; + } + + return self; +} + +- (void) dealloc { + [_pasteboard release]; + [super dealloc]; +} + +- (void) sendContentOfMimeType: (NSString *) mimeType + toFileHandle: (NSFileHandle *) fileHandle +{ + OwlPasteboardType *type = [[OwlPasteboardType alloc] initWithMimeType: mimeType]; + NSData *data; + NSString *uti = [type UTI]; + if ([type isText]) { + NSString *s = [_pasteboard stringForType: uti]; + data = [s dataUsingEncoding: NSUTF8StringEncoding]; + } else { + data = [_pasteboard dataForType: uti]; + } + [type release]; + [fileHandle writeData: data]; +} + +- (void) sendCancelled { + // Do nothing. +} + +@end diff --git a/Sources/Data/OwlPasteboardType.h b/Sources/Data/OwlPasteboardType.h new file mode 100644 index 0000000..1346879 --- /dev/null +++ b/Sources/Data/OwlPasteboardType.h @@ -0,0 +1,35 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> + + +@interface OwlPasteboardType : NSObject { + NSString *_mimeType; + NSString *_uti; +} + +- (id) initWithMimeType: (NSString *) mimeType; +- (id) initWithUTI: (NSString *) UTI; + +- (NSString *) mimeType; +- (NSString *) UTI; + +- (BOOL) isText; + +@end diff --git a/Sources/Data/OwlPasteboardType.m b/Sources/Data/OwlPasteboardType.m new file mode 100644 index 0000000..888e8bb --- /dev/null +++ b/Sources/Data/OwlPasteboardType.m @@ -0,0 +1,103 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlPasteboardType.h" +#import "OwlFeatures.h" + + +@implementation OwlPasteboardType + +static NSArray *extraTextTypes; + ++ (void) initialize { + if (extraTextTypes == nil) { + extraTextTypes = [[NSArray alloc] initWithObjects: + @"TEXT", + @"STRING", + @"UTF8_STRING", + nil + ]; + } +} + +- (id) initWithMimeType: (NSString *) type { + _mimeType = [type retain]; + return self; +} + +- (id) initWithUTI: (NSString *) UTI { + _uti = [UTI retain]; + return self; +} + +- (void) dealloc { + [_mimeType release]; + [_uti release]; + [super dealloc]; +} + +- (NSString *) mimeType { + if (_mimeType == nil) { + if ([_uti isEqual: NSStringPboardType]) { + _mimeType = [@"text/plain" retain]; + } else if ([_uti isEqual: @"public.utf8-plain-text"]) { + _mimeType = [@"text/plain;charset=utf-8" retain]; + } else { +#ifdef OWL_PLATFORM_APPLE + _mimeType = (NSString *) UTTypeCopyPreferredTagWithClass( + (CFStringRef) _uti, + kUTTagClassMIMEType + ); +#else + _mimeType = [_uti retain]; +#endif + } + } + + return _mimeType; +} + +- (NSString *) UTI { + if (_uti == nil) { + if ( + [_mimeType hasPrefix: @"text/plain"] || + [extraTextTypes containsObject: _mimeType] + ) { + _uti = [NSStringPboardType retain]; + } else { +#ifdef OWL_PLATFORM_APPLE + _uti = (NSString *) UTTypeCreatePreferredIdentifierForTag( + kUTTagClassMIMEType, + (CFStringRef) _mimeType, + NULL + ); +#else + _uti = [_mimeType retain]; +#endif + } + } + + return _uti; +} + +- (BOOL) isText { + NSString *m = [self mimeType]; + return [m hasPrefix: @"text/"] || [extraTextTypes containsObject: m]; +} + +@end diff --git a/Sources/Data/OwlSelection.h b/Sources/Data/OwlSelection.h new file mode 100644 index 0000000..327bfdb --- /dev/null +++ b/Sources/Data/OwlSelection.h @@ -0,0 +1,49 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataSource.h" +#import "OwlFeatures.h" +#import <Cocoa/Cocoa.h> + +@class OwlDataDevice; + +// A selection represents a "place" or a "slot" where data can be copied to +// and pasted from. One selection can only hold one data source at a time. +// +// There's a single global selection that represents the system clipboard. +// On GNUstep, there's additionally the primary selection. +@interface OwlSelection : NSObject <OwlDataSourceHolder> { + OwlDataSource *_dataSource; + NSMutableArray *_dataDevices; +} + ++ (OwlSelection *) clipboard; +#ifdef OWL_PLATFORM_GNUSTEP ++ (OwlSelection *) primary; +#endif + +// Get and set the contents of the selction, as a data source. +- (OwlDataSource *) dataSource; +- (void) setDataSource: (OwlDataSource *) dataSource; + +// Subscribe and unsubscribe data devices. +// OwlSelection will call -selectionChanged: on the registered data devices. +- (void) addDataDevice: (OwlDataDevice *) dataDevice; +- (void) removeDataDevice: (OwlDataDevice *) dataDevice; + +@end diff --git a/Sources/Data/OwlSelection.m b/Sources/Data/OwlSelection.m new file mode 100644 index 0000000..a69a659 --- /dev/null +++ b/Sources/Data/OwlSelection.m @@ -0,0 +1,100 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSelection.h" +#import "OwlDataSource.h" +#import "OwlDataDevice.h" +#import "OwlFeatures.h" + + +@implementation OwlSelection + +- (id) init { + _dataDevices = [NSMutableArray new]; + return self; +} + +- (void) dealloc { + [_dataDevices release]; + [_dataSource removeHolder: self]; + [_dataSource release]; + [super dealloc]; +} + ++ (OwlSelection *) clipboard { + static OwlSelection *clipboard; + if (clipboard == nil) { + clipboard = [[OwlSelection alloc] init]; + } + return clipboard; +} + +#ifdef OWL_PLATFORM_GNUSTEP ++ (OwlSelection *) primary { + static OwlSelection *primary; + if (primary == nil) { + primary = [[OwlSelection alloc] init]; + } + return primary; +} +#endif + +// Get the current data source. +- (OwlDataSource *) dataSource { + return _dataSource; +} + +- (void) setDataSource: (OwlDataSource *) source { + if (source == _dataSource) { + return; + } + + // Clean up the old data source. + [_dataSource sendCancelled]; + [_dataSource removeHolder: self]; + [_dataSource release]; + + // Set up the new one. + _dataSource = [source retain]; + [_dataSource addHolder: self]; + + // Broadcast it to the data devices that we have a new data source. + for (NSValue *value in _dataDevices) { + OwlDataDevice *dataDevice = [value nonretainedObjectValue]; + [dataDevice selectionChanged: self]; + } +} + +- (void) addDataDevice: (OwlDataDevice *) dataDevice { + NSValue *value = [NSValue valueWithNonretainedObject: dataDevice]; + [_dataDevices addObject: value]; +} + +- (void) removeDataDevice: (OwlDataDevice *) dataDevice { + NSValue *value = [NSValue valueWithNonretainedObject: dataDevice]; + [_dataDevices removeObject: value]; +} + +- (void) releaseDataSource: (OwlDataSource *) source { + if (_dataSource == source) { + [_dataSource release]; + _dataSource = nil; + } +} + +@end diff --git a/Sources/Data/OwlWlDataDevice.h b/Sources/Data/OwlWlDataDevice.h new file mode 100644 index 0000000..730c7ab --- /dev/null +++ b/Sources/Data/OwlWlDataDevice.h @@ -0,0 +1,34 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataDevice.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlWlDataDevice : OwlDataDevice { + NSUInteger _focusCount; + BOOL _selectionHasChangedSinceLastFocused; +} + ++ (OwlWlDataDevice *) dataDeviceForClient: (struct wl_client *) client; + +- (void) focused; +- (void) unfocused; + +@end diff --git a/Sources/Data/OwlWlDataDevice.m b/Sources/Data/OwlWlDataDevice.m new file mode 100644 index 0000000..e895692 --- /dev/null +++ b/Sources/Data/OwlWlDataDevice.m @@ -0,0 +1,143 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlWlDataDevice.h" +#import <wayland-server.h> +#import "OwlWlDataSource.h" +#import "OwlWlDataOffer.h" +#import "OwlSelection.h" + + +@implementation OwlWlDataDevice + +static NSMutableArray *dataDevices; + ++ (void) initialize { + if (dataDevices == nil) { + dataDevices = [[NSMutableArray alloc] initWithCapacity: 1]; + } +} + ++ (OwlWlDataDevice *) dataDeviceForClient: (struct wl_client *) client { + for (OwlWlDataDevice *dataDevice in dataDevices) { + struct wl_resource *resource = dataDevice->_resource; + if (client == wl_resource_get_client(resource)) { + return dataDevice; + } + } + return nil; +} + +static void data_device_destroy(struct wl_resource *resource) { + OwlWlDataDevice *self = wl_resource_get_user_data(resource); + [dataDevices removeObjectIdenticalTo: self]; + [self release]; +} + +static void data_device_set_selection_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *source_resource, + uint32_t serial +) { + // TODO: Check the serial corresponds to an event of the focused surface + // and the event is not it gaining focus. + OwlWlDataDevice *self = wl_resource_get_user_data(resource); + OwlWlDataSource *dataSource = nil; + if (source_resource != NULL) { + dataSource = wl_resource_get_user_data(source_resource); + } + [[OwlSelection clipboard] setDataSource: dataSource]; +} + +static void data_device_release_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static const struct wl_data_device_interface data_device_impl = { + .set_selection = data_device_set_selection_handler, + .release = data_device_release_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource { + self = [super initWithResource: resource]; + wl_resource_set_implementation( + resource, + &data_device_impl, + [self retain], + data_device_destroy + ); + [dataDevices addObject: self]; + [[OwlSelection clipboard] addDataDevice: self]; + // FIXME: Call [self focused] here if we already have focus. + [self selectionChanged: [OwlSelection clipboard]]; + return self; +} + +- (void) dealloc { + [[OwlSelection clipboard] removeDataDevice: self]; + [super dealloc]; +} + +- (void) sendSelection { + _selectionHasChangedSinceLastFocused = NO; + OwlDataSource *dataSource = [[OwlSelection clipboard] dataSource]; + + if (dataSource == nil) { + wl_data_device_send_selection(_resource, NULL); + return; + } + + struct wl_resource *offer_resource = wl_resource_create( + wl_resource_get_client(_resource), + &wl_data_offer_interface, + 2, + 0 + ); + wl_data_device_send_data_offer(_resource, offer_resource); + // Creating an OwlDataOffer sends out the MIME types automatically. + OwlWlDataOffer *offer = + [[OwlWlDataOffer alloc] initWithResource: offer_resource + dataSource: dataSource]; + wl_data_device_send_selection(_resource, offer_resource); + [offer release]; +} + +- (void) selectionChanged: (OwlSelection *) selection { + if (_focusCount > 0) { + [self sendSelection]; + } else { + _selectionHasChangedSinceLastFocused = YES; + } +} + +- (void) focused { + _focusCount++; + if (_focusCount == 1 && _selectionHasChangedSinceLastFocused) { + [self sendSelection]; + } +} + +- (void) unfocused { + _focusCount--; +} + +@end diff --git a/Sources/Data/OwlWlDataDeviceManager.h b/Sources/Data/OwlWlDataDeviceManager.h new file mode 100644 index 0000000..b4ce6d7 --- /dev/null +++ b/Sources/Data/OwlWlDataDeviceManager.h @@ -0,0 +1,30 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlWlDataDeviceManager : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +@end diff --git a/Sources/Data/OwlWlDataDeviceManager.m b/Sources/Data/OwlWlDataDeviceManager.m new file mode 100644 index 0000000..854b910 --- /dev/null +++ b/Sources/Data/OwlWlDataDeviceManager.m @@ -0,0 +1,101 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlWlDataDeviceManager.h" +#import "OwlWlDataSource.h" +#import "OwlWlDataDevice.h" + + +@implementation OwlWlDataDeviceManager + +static void data_device_manager_destroy(struct wl_resource *resource) { + OwlWlDataDeviceManager *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void data_device_manager_create_data_source_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + struct wl_resource *data_source_resource = wl_resource_create( + client, + &wl_data_source_interface, + 2, + id + ); + [[[OwlWlDataSource alloc] initWithResource: data_source_resource] release]; +} + +static void data_device_manager_get_data_device_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id, + struct wl_resource *seat_resource +) { + struct wl_resource *data_device_resource = wl_resource_create( + client, + &wl_data_device_interface, + 2, + id + ); + [[[OwlWlDataDevice alloc] initWithResource: data_device_resource] release]; +} + +static const struct wl_data_device_manager_interface data_device_manager_impl = { + .create_data_source = data_device_manager_create_data_source_handler, + .get_data_device = data_device_manager_get_data_device_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &data_device_manager_impl, + [self retain], + data_device_manager_destroy + ); + return self; +} + +static void data_device_manager_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &wl_data_device_manager_interface, + version, + id + ); + [[[OwlWlDataDeviceManager alloc] initWithResource: resource] release]; +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create( + display, + &wl_data_device_manager_interface, + 2, + NULL, + data_device_manager_bind + ); +} + +@end diff --git a/Sources/Data/OwlWlDataOffer.h b/Sources/Data/OwlWlDataOffer.h new file mode 100644 index 0000000..b7508e0 --- /dev/null +++ b/Sources/Data/OwlWlDataOffer.h @@ -0,0 +1,26 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataOffer.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlWlDataOffer : OwlDataOffer + +@end diff --git a/Sources/Data/OwlWlDataOffer.m b/Sources/Data/OwlWlDataOffer.m new file mode 100644 index 0000000..8e6acfc --- /dev/null +++ b/Sources/Data/OwlWlDataOffer.m @@ -0,0 +1,77 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlWlDataOffer.h" + + +@implementation OwlWlDataOffer + +static void data_offer_destroy(struct wl_resource *resource) { + OwlWlDataOffer *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void data_offer_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void data_offer_accept( + struct wl_client *client, + struct wl_resource *resource, + uint32_t serial, + const char *mime_type +) { + // TODO +} + +static void data_offer_receive_handler( + struct wl_client *client, + struct wl_resource *resource, + const char *mime_type, + int fd +) { + OwlWlDataOffer *self = wl_resource_get_user_data(resource); + [self receiveContentOfMimeType: mime_type intoFileDescriptor: fd]; +} + +static const struct wl_data_offer_interface data_offer_impl = { + .destroy = data_offer_destroy_handler, + .receive = data_offer_receive_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource + dataSource: (OwlDataSource *) source +{ + self = [super initWithResource: resource dataSource: source]; + wl_resource_set_implementation( + resource, + &data_offer_impl, + [self retain], + data_offer_destroy + ); + return self; +} + +- (void) addMimeType: (NSString *) mimeType { + wl_data_offer_send_offer(_resource, [mimeType UTF8String]); +} + +@end diff --git a/Sources/Data/OwlWlDataSource.h b/Sources/Data/OwlWlDataSource.h new file mode 100644 index 0000000..c2e912b --- /dev/null +++ b/Sources/Data/OwlWlDataSource.h @@ -0,0 +1,25 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataSource.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlWlDataSource : OwlDataSource +@end diff --git a/Sources/Data/OwlWlDataSource.m b/Sources/Data/OwlWlDataSource.m new file mode 100644 index 0000000..a5d1ee4 --- /dev/null +++ b/Sources/Data/OwlWlDataSource.m @@ -0,0 +1,76 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlWlDataSource.h" + + +@implementation OwlWlDataSource + +static void data_source_destroy(struct wl_resource *resource) { + OwlWlDataSource *self = wl_resource_get_user_data(resource); + [self releaseFromHolders]; + [self release]; +} + +static void data_source_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void data_source_offer_handler( + struct wl_client *client, + struct wl_resource *resource, + const char *mime_type +) { + OwlWlDataSource *self = wl_resource_get_user_data(resource); + [self->_mimeTypes addObject: [NSString stringWithUTF8String: mime_type]]; +} + +static const struct wl_data_source_interface data_source_impl = { + .destroy = data_source_destroy_handler, + .offer = data_source_offer_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource { + self = [super initWithResource: resource]; + wl_resource_set_implementation( + resource, + &data_source_impl, + [self retain], + data_source_destroy + ); + return self; +} + +- (void) sendContentOfMimeType: (NSString *) mimeType + toFileHandle: (NSFileHandle *) fileHandle +{ + wl_data_source_send_send( + _resource, + [mimeType UTF8String], + [fileHandle fileDescriptor] + ); +} + +- (void) sendCancelled { + wl_data_source_send_cancelled(_resource); +} + +@end diff --git a/Sources/Data/OwlZwlrDataControlDeviceV1.h b/Sources/Data/OwlZwlrDataControlDeviceV1.h new file mode 100644 index 0000000..f05163f --- /dev/null +++ b/Sources/Data/OwlZwlrDataControlDeviceV1.h @@ -0,0 +1,25 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataDevice.h" +#import <Cocoa/Cocoa.h> + + +@interface OwlZwlrDataControlDeviceV1 : OwlDataDevice + +@end diff --git a/Sources/Data/OwlZwlrDataControlDeviceV1.m b/Sources/Data/OwlZwlrDataControlDeviceV1.m new file mode 100644 index 0000000..cc5632b --- /dev/null +++ b/Sources/Data/OwlZwlrDataControlDeviceV1.m @@ -0,0 +1,151 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlZwlrDataControlDeviceV1.h" +#import "wlr-data-control-unstable-v1.h" +#import "OwlZwlrDataControlSourceV1.h" +#import "OwlZwlrDataControlOfferV1.h" +#import "OwlSelection.h" +#import "OwlFeatures.h" +#import <wayland-server.h> + + +@implementation OwlZwlrDataControlDeviceV1 + +static void data_control_device_destroy(struct wl_resource *resource) { + OwlZwlrDataControlDeviceV1 *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void data_control_device_set_selection_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *source_resource +) { + OwlZwlrDataControlDeviceV1 *self = wl_resource_get_user_data(resource); + OwlZwlrDataControlSourceV1 *dataSource = nil; + if (source_resource != NULL) { + dataSource = (OwlZwlrDataControlSourceV1 *) wl_resource_get_user_data(source_resource); + } + [[OwlSelection clipboard] setDataSource: dataSource]; +} + +#ifdef OWL_PLATFORM_GNUSTEP +static void data_control_device_set_primary_selection_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *source_resource +) { + OwlZwlrDataControlDeviceV1 *self = wl_resource_get_user_data(resource); + OwlZwlrDataControlSourceV1 *dataSource = nil; + if (source_resource != NULL) { + dataSource = (OwlZwlrDataControlSourceV1 *) wl_resource_get_user_data(source_resource); + } + [[OwlSelection primary] setDataSource: dataSource]; +} +#endif + +static void data_control_device_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static const struct zwlr_data_control_device_v1_interface data_control_device_impl = { + .set_selection = data_control_device_set_selection_handler, +#ifdef OWL_PLATFORM_GNUSTEP + .set_primary_selection = data_control_device_set_primary_selection_handler, +#endif + .destroy = data_control_device_destroy_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource { + self = [super initWithResource: resource]; + wl_resource_set_implementation( + resource, + &data_control_device_impl, + [self retain], + data_control_device_destroy + ); + + [[OwlSelection clipboard] addDataDevice: self]; + [self selectionChanged: [OwlSelection clipboard]]; +#ifdef OWL_PLATFORM_GNUSTEP + [[OwlSelection primary] addDataDevice: self]; + [self selectionChanged: [OwlSelection primary]]; +#endif + + return self; +} + +- (void) dealloc { + [[OwlSelection clipboard] removeDataDevice: self]; +#ifdef OWL_PLATFORM_GNUSTEP + [[OwlSelection primary] removeDataDevice: self]; +#endif + [super dealloc]; +} + +- (void) sendOffer: (OwlZwlrDataControlOfferV1 *) offer + forSelection: (OwlSelection *) selection +{ + struct wl_resource *offer_resource = [offer resource]; + + if (selection == [OwlSelection clipboard]) { + zwlr_data_control_device_v1_send_selection(_resource, offer_resource); +#ifdef OWL_PLATFORM_GNUSTEP + } else if (selection == [OwlSelection primary]) { + if (wl_resource_get_version(_resource) >= 2) { + zwlr_data_control_device_v1_send_primary_selection( + _resource, + offer_resource + ); + } +#endif + } else { + [NSException raise: NSInternalInconsistencyException + format: @"Unexpected selection: %@", selection]; + } +} + +- (void) selectionChanged: (OwlSelection *) selection { + OwlDataSource *dataSource = [selection dataSource]; + + if (dataSource == nil) { + [self sendOffer: nil forSelection: selection]; + return; + } + + // Introduce a new offer to the client. + struct wl_resource *offer_resource = wl_resource_create( + wl_resource_get_client(_resource), + &zwlr_data_control_offer_v1_interface, + wl_resource_get_version(_resource), + 0 + ); + zwlr_data_control_device_v1_send_data_offer(_resource, offer_resource); + // Creating an OwlDataOffer sends out the MIME types automatically. + OwlZwlrDataControlOfferV1 *offer = + [[OwlZwlrDataControlOfferV1 alloc] initWithResource: offer_resource + dataSource: dataSource]; + [self sendOffer: offer forSelection: selection]; + [offer release]; +} + +@end diff --git a/Sources/Data/OwlZwlrDataControlManagerV1.h b/Sources/Data/OwlZwlrDataControlManagerV1.h new file mode 100644 index 0000000..a241bc6 --- /dev/null +++ b/Sources/Data/OwlZwlrDataControlManagerV1.h @@ -0,0 +1,30 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlZwlrDataControlManagerV1 : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +@end diff --git a/Sources/Data/OwlZwlrDataControlManagerV1.m b/Sources/Data/OwlZwlrDataControlManagerV1.m new file mode 100644 index 0000000..293b101 --- /dev/null +++ b/Sources/Data/OwlZwlrDataControlManagerV1.m @@ -0,0 +1,113 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlZwlrDataControlManagerV1.h" +#import "OwlZwlrDataControlDeviceV1.h" +#import "OwlZwlrDataControlSourceV1.h" +#import "wlr-data-control-unstable-v1.h" +#import <wayland-server.h> + + +@implementation OwlZwlrDataControlManagerV1 + +static void data_control_manager_destroy(struct wl_resource *resource) { + OwlZwlrDataControlManagerV1 *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void data_control_manager_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void data_control_manager_create_data_source_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + uint32_t version = wl_resource_get_version(resource); + struct wl_resource *data_source_resource = wl_resource_create( + client, + &zwlr_data_control_source_v1_interface, + version, + id + ); + [[[OwlZwlrDataControlSourceV1 alloc] initWithResource: data_source_resource] release]; +} + +static void data_control_manager_get_data_device_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id, + struct wl_resource *seat_resource +) { + uint32_t version = wl_resource_get_version(resource); + struct wl_resource *data_device_resource = wl_resource_create( + client, + &zwlr_data_control_device_v1_interface, + version, + id + ); + [[[OwlZwlrDataControlDeviceV1 alloc] initWithResource: data_device_resource] release]; +} + +static const struct zwlr_data_control_manager_v1_interface data_control_manager_impl = { + .create_data_source = data_control_manager_create_data_source_handler, + .get_data_device = data_control_manager_get_data_device_handler, + .destroy = data_control_manager_destroy_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &data_control_manager_impl, + [self retain], + data_control_manager_destroy + ); + return self; +} + +static void data_control_manager_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &zwlr_data_control_manager_v1_interface, + version, + id + ); + [[[OwlZwlrDataControlManagerV1 alloc] initWithResource: resource] release]; +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create( + display, + &zwlr_data_control_manager_v1_interface, + 2, + NULL, + data_control_manager_bind + ); +} + +@end diff --git a/Sources/Data/OwlZwlrDataControlOfferV1.h b/Sources/Data/OwlZwlrDataControlOfferV1.h new file mode 100644 index 0000000..f309c47 --- /dev/null +++ b/Sources/Data/OwlZwlrDataControlOfferV1.h @@ -0,0 +1,26 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataOffer.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlZwlrDataControlOfferV1 : OwlDataOffer + +@end diff --git a/Sources/Data/OwlZwlrDataControlOfferV1.m b/Sources/Data/OwlZwlrDataControlOfferV1.m new file mode 100644 index 0000000..f627ccc --- /dev/null +++ b/Sources/Data/OwlZwlrDataControlOfferV1.m @@ -0,0 +1,70 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlZwlrDataControlOfferV1.h" +#import "wlr-data-control-unstable-v1.h" +#import <wayland-server.h> + + +@implementation OwlZwlrDataControlOfferV1 + +static void data_control_offer_destroy(struct wl_resource *resource) { + OwlZwlrDataControlOfferV1 *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void data_control_offer_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void data_control_offer_receive_handler( + struct wl_client *client, + struct wl_resource *resource, + const char *mime_type, + int fd +) { + OwlZwlrDataControlOfferV1 *self = wl_resource_get_user_data(resource); + [self receiveContentOfMimeType: mime_type intoFileDescriptor: fd]; +} + +static const struct zwlr_data_control_offer_v1_interface data_control_offer_impl = { + .destroy = data_control_offer_destroy_handler, + .receive = data_control_offer_receive_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource + dataSource: (OwlDataSource *) source +{ + self = [super initWithResource: resource dataSource: source]; + wl_resource_set_implementation( + resource, + &data_control_offer_impl, + [self retain], + data_control_offer_destroy + ); + return self; +} + +- (void) addMimeType: (NSString *) mimeType { + zwlr_data_control_offer_v1_send_offer(_resource, [mimeType UTF8String]); +} + +@end diff --git a/Sources/Data/OwlZwlrDataControlSourceV1.h b/Sources/Data/OwlZwlrDataControlSourceV1.h new file mode 100644 index 0000000..90b5776 --- /dev/null +++ b/Sources/Data/OwlZwlrDataControlSourceV1.h @@ -0,0 +1,26 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlDataSource.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlZwlrDataControlSourceV1 : OwlDataSource + +@end diff --git a/Sources/Data/OwlZwlrDataControlSourceV1.m b/Sources/Data/OwlZwlrDataControlSourceV1.m new file mode 100644 index 0000000..7e269c1 --- /dev/null +++ b/Sources/Data/OwlZwlrDataControlSourceV1.m @@ -0,0 +1,78 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlZwlrDataControlSourceV1.h" +#import <wayland-server.h> +#import "wlr-data-control-unstable-v1.h" + + +@implementation OwlZwlrDataControlSourceV1 + +static void data_control_source_destroy(struct wl_resource *resource) { + OwlZwlrDataControlSourceV1 *self = wl_resource_get_user_data(resource); + [self releaseFromHolders]; + [self release]; +} + +static void data_control_source_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void data_control_source_offer_handler( + struct wl_client *client, + struct wl_resource *resource, + const char *mime_type +) { + OwlZwlrDataControlSourceV1 *self = wl_resource_get_user_data(resource); + [self->_mimeTypes addObject: [NSString stringWithUTF8String: mime_type]]; +} + +static const struct zwlr_data_control_source_v1_interface data_control_source_impl = { + .destroy = data_control_source_destroy_handler, + .offer = data_control_source_offer_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource { + self = [super initWithResource: resource]; + wl_resource_set_implementation( + resource, + &data_control_source_impl, + [self retain], + data_control_source_destroy + ); + return self; +} + +- (void) sendContentOfMimeType: (NSString *) mimeType + toFileHandle: (NSFileHandle *) fileHandle +{ + zwlr_data_control_source_v1_send_send( + _resource, + [mimeType UTF8String], + [fileHandle fileDescriptor] + ); +} + +- (void) sendCancelled { + zwlr_data_control_source_v1_send_cancelled(_resource); +} + +@end diff --git a/Sources/Mach/OwlMIG.h b/Sources/Mach/OwlMIG.h new file mode 100644 index 0000000..9b88d01 --- /dev/null +++ b/Sources/Mach/OwlMIG.h @@ -0,0 +1,45 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <mach/mach.h> +#import <dispatch/dispatch.h> + + + +// From source_private.h + +typedef boolean_t (*dispatch_mig_callback_t)( + mach_msg_header_t *message, + mach_msg_header_t *reply +); + +extern mach_msg_return_t dispatch_mig_server( + dispatch_source_t source, + size_t max_message_size, + dispatch_mig_callback_t callback +); + + +@interface OwlMIG : NSObject + ++ (void) serveOnPort: (mach_port_t) port + usingCallback: (dispatch_mig_callback_t) callback + maxSize: (size_t) maxSize; + +@end diff --git a/Sources/Mach/OwlMIG.m b/Sources/Mach/OwlMIG.m new file mode 100644 index 0000000..e9dabd7 --- /dev/null +++ b/Sources/Mach/OwlMIG.m @@ -0,0 +1,41 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlMIG.h" + + +@implementation OwlMIG + ++ (void) serveOnPort: (mach_port_t) port + usingCallback: (dispatch_mig_callback_t) + callback maxSize: (size_t) maxSize +{ + dispatch_source_t source = dispatch_source_create( + DISPATCH_SOURCE_TYPE_MACH_RECV, + port, + 0, + dispatch_get_main_queue() + ); + + dispatch_source_set_event_handler(source, ^{ + dispatch_mig_server(source, maxSize, callback); + }); + dispatch_resume(source); +} + +@end diff --git a/Sources/Mach/OwlZowlMachIpcPortV1.h b/Sources/Mach/OwlZowlMachIpcPortV1.h new file mode 100644 index 0000000..ec81c7e --- /dev/null +++ b/Sources/Mach/OwlZowlMachIpcPortV1.h @@ -0,0 +1,33 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> +#import <mach/mach.h> + + +@interface OwlZowlMachIpcPortV1 : NSObject { + struct wl_resource *_resource; + mach_port_t _port; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +- (void) setPort: (mach_port_t) port; + +@end diff --git a/Sources/Mach/OwlZowlMachIpcPortV1.m b/Sources/Mach/OwlZowlMachIpcPortV1.m new file mode 100644 index 0000000..577b42a --- /dev/null +++ b/Sources/Mach/OwlZowlMachIpcPortV1.m @@ -0,0 +1,94 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlZowlMachIpcPortV1.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> +#import "owl-mach-ipc-unstable-v1.h" +#import "owl-mach-ipc-unstable-v1-mig.h" + + +@implementation OwlZowlMachIpcPortV1 + +static NSMutableDictionary *secretToPort; + ++ (void) initialize { + if (secretToPort == nil) { + secretToPort = [[NSMutableDictionary alloc] init]; + } +} + +static void mach_ipc_port_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static const struct zowl_mach_ipc_port_v1_interface mach_ipc_port_impl = { + .destroy = mach_ipc_port_destroy_handler +}; + +static void mach_ipc_port_destroy(struct wl_resource *resource) { + OwlZowlMachIpcPortV1 *self = wl_resource_get_user_data(resource); + [secretToPort removeObjectsForKeys: [secretToPort allKeysForObject: self]]; + [self release]; +} + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &mach_ipc_port_impl, + [self retain], + mach_ipc_port_destroy + ); + + // Cannot use NSUUID, as it's 10.8+. + CFUUIDRef uuid = CFUUIDCreate(kCFAllocatorDefault); + NSString *secret = (NSString *) CFUUIDCreateString(kCFAllocatorDefault, uuid); + CFRelease(uuid); + + zowl_mach_ipc_port_v1_send_secret(resource, [secret UTF8String]); + [secretToPort setObject: self forKey: secret]; + [secret release]; + return self; +} + +- (void) setPort: (mach_port_t) port { + _port = port; +} + +// FIXME: deallocate the port in dealloc? + +kern_return_t owl_mach_ipc_v1_server_retrieve_port( + mach_port_t server_port, + secret_t raw_secret, + mach_port_t *port +) { + NSString *secret = [NSString stringWithUTF8String: raw_secret]; + OwlZowlMachIpcPortV1 *self = [secretToPort objectForKey: secret]; + if (self == nil) { + return KERN_INVALID_ARGUMENT; + } + [secretToPort removeObjectForKey: secret]; + *port = self->_port; + return KERN_SUCCESS; +} + +@end diff --git a/Sources/Mach/OwlZowlMachIpcV1.h b/Sources/Mach/OwlZowlMachIpcV1.h new file mode 100644 index 0000000..5e8c490 --- /dev/null +++ b/Sources/Mach/OwlZowlMachIpcV1.h @@ -0,0 +1,31 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> +#import "owl-mach-ipc-unstable-v1.h" + + +@interface OwlZowlMachIpcV1 : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + ++ (BOOL) bootstrapCheckInWithName: (NSString *) name; + +@end diff --git a/Sources/Mach/OwlZowlMachIpcV1.m b/Sources/Mach/OwlZowlMachIpcV1.m new file mode 100644 index 0000000..fddafe1 --- /dev/null +++ b/Sources/Mach/OwlZowlMachIpcV1.m @@ -0,0 +1,119 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlZowlMachIpcV1.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> +#import "owl-mach-ipc-unstable-v1.h" +#import "owl-mach-ipc-unstable-v1-mig.h" +#import <mach/mach.h> +#import <servers/bootstrap.h> +#import "OwlZowlMachIpcPortV1.h" +#import "OwlMIG.h" + +@implementation OwlZowlMachIpcV1 + +static NSString *globalName; +static mach_port_t port; + ++ (BOOL) bootstrapCheckInWithName: (NSString *) name { + globalName = [name retain]; + const char *raw_name = [name UTF8String]; + kern_return_t kr = bootstrap_check_in(bootstrap_port, raw_name, &port); + if (kr != KERN_SUCCESS) { + NSLog(@"bootstrap_check_in(%@) = %x", name, kr); + return NO; + } else { + NSLog(@"Checked in with the bootstrap server as %@", name); + } + + [OwlMIG serveOnPort: port + usingCallback: owl_mach_ipc_v1_server + maxSize: 100]; + return YES; +} + +static void mach_ipc_destroy(struct wl_resource *resource) { + OwlZowlMachIpcV1 *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void mach_ipc_create_port_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + struct wl_resource *port_resource = wl_resource_create( + client, + &zowl_mach_ipc_port_v1_interface, + 1, + id + ); + [[[OwlZowlMachIpcPortV1 alloc] initWithResource: port_resource] release]; +} + +static void mach_ipc_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static const struct zowl_mach_ipc_v1_interface mach_ipc_impl = { + .create_port = mach_ipc_create_port_handler, + .destroy = mach_ipc_destroy_handler +}; + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &mach_ipc_impl, + [self retain], + mach_ipc_destroy + ); + zowl_mach_ipc_v1_send_bootstrap_name(resource, [globalName UTF8String]); + return self; +} + +static void mach_ipc_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &zowl_mach_ipc_v1_interface, + version, + id + ); + [[[OwlZowlMachIpcV1 alloc] initWithResource: resource] release]; +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create( + display, + &zowl_mach_ipc_v1_interface, + 1, + NULL, + mach_ipc_bind + ); +} + +@end diff --git a/Sources/OwlFeatures.h b/Sources/OwlFeatures.h new file mode 100644 index 0000000..a997253 --- /dev/null +++ b/Sources/OwlFeatures.h @@ -0,0 +1,29 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#ifdef __APPLE__ + #define OWL_PLATFORM_APPLE +#else + #undef OWL_PLATFORM_APPLE +#endif + +#ifdef GS_API_VERSION + #define OWL_PLATFORM_GNUSTEP +#else + #undef OWL_PLATFORM_GNUSTEP +#endif diff --git a/Sources/Protocol/owl-iosurface-unstable-v1-mig.defs b/Sources/Protocol/owl-iosurface-unstable-v1-mig.defs new file mode 100644 index 0000000..c845e5e --- /dev/null +++ b/Sources/Protocol/owl-iosurface-unstable-v1-mig.defs @@ -0,0 +1,10 @@ +subsystem owl_iosurface_v1 35422; + +#include <mach/std_types.defs> + +userprefix owl_iosurface_v1_; +serverprefix owl_iosurface_v1_server_; + +routine set_surface_port( + receiver_port: mach_port_t; + iosurface_port: mach_port_t); diff --git a/Sources/Protocol/owl-iosurface-unstable-v1.xml b/Sources/Protocol/owl-iosurface-unstable-v1.xml new file mode 100644 index 0000000..dd252af --- /dev/null +++ b/Sources/Protocol/owl-iosurface-unstable-v1.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8"?> +<protocol name="owl_iosurface_unstable_v1"> + + <copyright> + Copyright © 2019-2021 Sergey Bugaev + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + </copyright> + + <interface name="zowl_iosurface_manager_v1" version="1"> + <description summary="use IOSurface for sharing GPU buffer resources"> + TODO + </description> + + <request name="create_surface"> + <description summary="create an IOSurface"> + This request assigns the zowl_mach_ipc_port_v1 object a role of the IOSurface + receiver. After sending this request, it is possible to call the + owl_iosurface_v1_set_surface_port() MIG routine on its underlying Mach port. + </description> + <arg name="port" type="object" interface="zowl_mach_ipc_port_v1"/> + <arg name="id" type="new_id" interface="zowl_iosurface_v1"/> + </request> + + <request name="destroy" type="destructor"> + <description summary="destroy zowl_iosurface_manager_v1"> + Destroy this zowl_iosurface_manager_v1 object and all the resources associated + with it. Destroying a zowl_iosurface_manager_v1 object while an IOSurface that + was created using it is in use is an error. + </description> + </request> + </interface> + + <interface name="zowl_iosurface_v1" version="1"> + <description summary="IOSurface"> + TODO + </description> + + <request name="create_buffer"> + <description summary="create wl_buffer"> + Create a wl_buffer out of this zowl_iosurface_v1 object. This request must be + preceeded by the client creating an IOSurface object with the desired size + and sending its Mach port using the owl_iosurface_v1_set_surface_port() MIG + routine on the Mach port that was used to create this zowl_iosurface_v1 object. + </description> + <arg name="id" type="new_id" interface="wl_buffer"/> + </request> + + <request name="destroy" type="destructor"> + <description summary="destroy zowl_iosurface_v1"> + Destroy this zowl_iosurface_v1 object and all the resources associated + with it, including the underlying IOSurface. + </description> + </request> + </interface> +</protocol> diff --git a/Sources/Protocol/owl-mach-ipc-unstable-v1-mig-types.h b/Sources/Protocol/owl-mach-ipc-unstable-v1-mig-types.h new file mode 100644 index 0000000..8a513c2 --- /dev/null +++ b/Sources/Protocol/owl-mach-ipc-unstable-v1-mig-types.h @@ -0,0 +1 @@ +typedef const char *secret_t; diff --git a/Sources/Protocol/owl-mach-ipc-unstable-v1-mig.defs b/Sources/Protocol/owl-mach-ipc-unstable-v1-mig.defs new file mode 100644 index 0000000..4572458 --- /dev/null +++ b/Sources/Protocol/owl-mach-ipc-unstable-v1-mig.defs @@ -0,0 +1,14 @@ +subsystem owl_mach_ipc_v1 35421; + +#include <mach/std_types.defs> +import "owl-mach-ipc-unstable-v1-mig-types.h"; + +userprefix owl_mach_ipc_v1_; +serverprefix owl_mach_ipc_v1_server_; + +type secret_t = c_string[*:80]; + +routine retrieve_port( + server_port: mach_port_t; + secret: secret_t; + out port: mach_port_make_send_t); diff --git a/Sources/Protocol/owl-mach-ipc-unstable-v1.xml b/Sources/Protocol/owl-mach-ipc-unstable-v1.xml new file mode 100644 index 0000000..ee103bc --- /dev/null +++ b/Sources/Protocol/owl-mach-ipc-unstable-v1.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8"?> +<protocol name="owl_mach_ipc_unstable_v1"> + + <copyright> + Copyright © 2019-2021 Sergey Bugaev + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + </copyright> + + <interface name="zowl_mach_ipc_v1" version="1"> + <description summary="communicate over Mach IPC"> + This protocol allows the client and the compositor to set up a connection over + Mach IPC using the Mach bootstrap server. This may be useful for a number of + reasons, including sharing resources that can only be shared over a Mach IPC-based + API. + + This protocol does not, by itself, assign any meaning or semantics to the Mach ports + it creates. In order for any port to be actually used for any concrete task, it needs + to be assigned a role, which determines what other operations (such as MIG routines) + are valid to be used on it. + + See owl-iosurface for an example of a protocol that makes use of owl-mach-ipc. + </description> + + <event name="bootstrap_name"> + <description summary="announce the bootstrap name"> + By sending this event, the compositor announces the bootstrap service name + it uses. The client is then expected to look up the compositor's Mach port + using a call such as bootstrap_look_up(). + </description> + <arg name="name" type="string"/> + </event> + + <request name="create_port"> + <description summary="create a Mach port"> + This request creates a zowl_mach_ipc_port_v1 object that wraps a Mach port + that is usable for communication between the server and the client. This request + by itself does not create the underlying Mach port of the zowl_mach_ipc_port_v1 + object. In order to create or otherwise get the underlying Mach port, the + zowl_mach_ipc_port_v1 needs to be assigned a role first. + </description> + <arg name="id" type="new_id" interface="zowl_mach_ipc_port_v1"/> + </request> + + <request name="destroy" type="destructor"> + <description summary="destroy zowl_mach_ipc_v1"> + Destroy this zowl_mach_ipc_v1 object and all the resources associated with + it. Destroying a zowl_mach_ipc_v1 object while a Mach port that was created + using it is in use is an error. + </description> + </request> + </interface> + + <interface name="zowl_mach_ipc_port_v1" version="1"> + <description summary="Mach port"> + This interface represents a Mach IPC port. To create or otherwise get the underlying + Mach port, as well as to make use of it, this object needs to be assigned a role + using some other protocol (such as owl-iosurface). + + After this object has been assigned a role, the client can retrieve the underlying + mach_port_t (as a send right) using the owl_mach_ipc_v1_retrieve_port() MIG routine, + passing the port obtained from the bootstrap server and the secret sent by the server + in the zowl_mach_ipc_port_v1.secret event. + </description> + + <event name="secret"> + <description summary="announce the secret key"> + This event announces the secret key that the client can pass into the + owl_mach_ipc_v1_retrieve_port() MIG routine in order to retrieve the underlying + mach_port_t of this zowl_mach_ipc_port_v1. + + The secret key is both a security measure that prevents other processes from + impersonating the client, and a way for the compositor to know which + zowl_mach_ipc_port_v1 instance the port is requested for. + </description> + <arg name="secret" type="string"/> + </event> + + <request name="destroy" type="destructor"> + <description summary="destroy zowl_mach_ipc_port_v1"> + Destroy this zowl_mach_ipc_port_v1 object and all the resources associated + with it, including the underlying Mach port, if it is still valid. + </description> + </request> + </interface> +</protocol> diff --git a/Sources/Protocol/wlr-data-control-unstable-v1.xml b/Sources/Protocol/wlr-data-control-unstable-v1.xml new file mode 100644 index 0000000..75e8671 --- /dev/null +++ b/Sources/Protocol/wlr-data-control-unstable-v1.xml @@ -0,0 +1,278 @@ +<?xml version="1.0" encoding="UTF-8"?> +<protocol name="wlr_data_control_unstable_v1"> + <copyright> + Copyright © 2018 Simon Ser + Copyright © 2019 Ivan Molodetskikh + + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that copyright notice and this permission + notice appear in supporting documentation, and that the name of + the copyright holders not be used in advertising or publicity + pertaining to distribution of the software without specific, + written prior permission. The copyright holders make no + representations about the suitability of this software for any + purpose. It is provided "as is" without express or implied + warranty. + + THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY + SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN + AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, + ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF + THIS SOFTWARE. + </copyright> + + <description summary="control data devices"> + This protocol allows a privileged client to control data devices. In + particular, the client will be able to manage the current selection and take + the role of a clipboard manager. + + Warning! The protocol described in this file is experimental and + backward incompatible changes may be made. Backward compatible changes + may be added together with the corresponding interface version bump. + Backward incompatible changes are done by bumping the version number in + the protocol and interface names and resetting the interface version. + Once the protocol is to be declared stable, the 'z' prefix and the + version number in the protocol and interface names are removed and the + interface version number is reset. + </description> + + <interface name="zwlr_data_control_manager_v1" version="2"> + <description summary="manager to control data devices"> + This interface is a manager that allows creating per-seat data device + controls. + </description> + + <request name="create_data_source"> + <description summary="create a new data source"> + Create a new data source. + </description> + <arg name="id" type="new_id" interface="zwlr_data_control_source_v1" + summary="data source to create"/> + </request> + + <request name="get_data_device"> + <description summary="get a data device for a seat"> + Create a data device that can be used to manage a seat's selection. + </description> + <arg name="id" type="new_id" interface="zwlr_data_control_device_v1"/> + <arg name="seat" type="object" interface="wl_seat"/> + </request> + + <request name="destroy" type="destructor"> + <description summary="destroy the manager"> + All objects created by the manager will still remain valid, until their + appropriate destroy request has been called. + </description> + </request> + </interface> + + <interface name="zwlr_data_control_device_v1" version="2"> + <description summary="manage a data device for a seat"> + This interface allows a client to manage a seat's selection. + + When the seat is destroyed, this object becomes inert. + </description> + + <request name="set_selection"> + <description summary="copy data to the selection"> + This request asks the compositor to set the selection to the data from + the source on behalf of the client. + + The given source may not be used in any further set_selection or + set_primary_selection requests. Attempting to use a previously used + source is a protocol error. + + To unset the selection, set the source to NULL. + </description> + <arg name="source" type="object" interface="zwlr_data_control_source_v1" + allow-null="true"/> + </request> + + <request name="destroy" type="destructor"> + <description summary="destroy this data device"> + Destroys the data device object. + </description> + </request> + + <event name="data_offer"> + <description summary="introduce a new wlr_data_control_offer"> + The data_offer event introduces a new wlr_data_control_offer object, + which will subsequently be used in either the + wlr_data_control_device.selection event (for the regular clipboard + selections) or the wlr_data_control_device.primary_selection event (for + the primary clipboard selections). Immediately following the + wlr_data_control_device.data_offer event, the new data_offer object + will send out wlr_data_control_offer.offer events to describe the MIME + types it offers. + </description> + <arg name="id" type="new_id" interface="zwlr_data_control_offer_v1"/> + </event> + + <event name="selection"> + <description summary="advertise new selection"> + The selection event is sent out to notify the client of a new + wlr_data_control_offer for the selection for this device. The + wlr_data_control_device.data_offer and the wlr_data_control_offer.offer + events are sent out immediately before this event to introduce the data + offer object. The selection event is sent to a client when a new + selection is set. The wlr_data_control_offer is valid until a new + wlr_data_control_offer or NULL is received. The client must destroy the + previous selection wlr_data_control_offer, if any, upon receiving this + event. + + The first selection event is sent upon binding the + wlr_data_control_device object. + </description> + <arg name="id" type="object" interface="zwlr_data_control_offer_v1" + allow-null="true"/> + </event> + + <event name="finished"> + <description summary="this data control is no longer valid"> + This data control object is no longer valid and should be destroyed by + the client. + </description> + </event> + + <!-- Version 2 additions --> + + <event name="primary_selection" since="2"> + <description summary="advertise new primary selection"> + The primary_selection event is sent out to notify the client of a new + wlr_data_control_offer for the primary selection for this device. The + wlr_data_control_device.data_offer and the wlr_data_control_offer.offer + events are sent out immediately before this event to introduce the data + offer object. The primary_selection event is sent to a client when a + new primary selection is set. The wlr_data_control_offer is valid until + a new wlr_data_control_offer or NULL is received. The client must + destroy the previous primary selection wlr_data_control_offer, if any, + upon receiving this event. + + If the compositor supports primary selection, the first + primary_selection event is sent upon binding the + wlr_data_control_device object. + </description> + <arg name="id" type="object" interface="zwlr_data_control_offer_v1" + allow-null="true"/> + </event> + + <request name="set_primary_selection" since="2"> + <description summary="copy data to the primary selection"> + This request asks the compositor to set the primary selection to the + data from the source on behalf of the client. + + The given source may not be used in any further set_selection or + set_primary_selection requests. Attempting to use a previously used + source is a protocol error. + + To unset the primary selection, set the source to NULL. + + The compositor will ignore this request if it does not support primary + selection. + </description> + <arg name="source" type="object" interface="zwlr_data_control_source_v1" + allow-null="true"/> + </request> + + <enum name="error" since="2"> + <entry name="used_source" value="1" + summary="source given to set_selection or set_primary_selection was already used before"/> + </enum> + </interface> + + <interface name="zwlr_data_control_source_v1" version="1"> + <description summary="offer to transfer data"> + The wlr_data_control_source object is the source side of a + wlr_data_control_offer. It is created by the source client in a data + transfer and provides a way to describe the offered data and a way to + respond to requests to transfer the data. + </description> + + <enum name="error"> + <entry name="invalid_offer" value="1" + summary="offer sent after wlr_data_control_device.set_selection"/> + </enum> + + <request name="offer"> + <description summary="add an offered MIME type"> + This request adds a MIME type to the set of MIME types advertised to + targets. Can be called several times to offer multiple types. + + Calling this after wlr_data_control_device.set_selection is a protocol + error. + </description> + <arg name="mime_type" type="string" + summary="MIME type offered by the data source"/> + </request> + + <request name="destroy" type="destructor"> + <description summary="destroy this source"> + Destroys the data source object. + </description> + </request> + + <event name="send"> + <description summary="send the data"> + Request for data from the client. Send the data as the specified MIME + type over the passed file descriptor, then close it. + </description> + <arg name="mime_type" type="string" summary="MIME type for the data"/> + <arg name="fd" type="fd" summary="file descriptor for the data"/> + </event> + + <event name="cancelled"> + <description summary="selection was cancelled"> + This data source is no longer valid. The data source has been replaced + by another data source. + + The client should clean up and destroy this data source. + </description> + </event> + </interface> + + <interface name="zwlr_data_control_offer_v1" version="1"> + <description summary="offer to transfer data"> + A wlr_data_control_offer represents a piece of data offered for transfer + by another client (the source client). The offer describes the different + MIME types that the data can be converted to and provides the mechanism + for transferring the data directly from the source client. + </description> + + <request name="receive"> + <description summary="request that the data is transferred"> + To transfer the offered data, the client issues this request and + indicates the MIME type it wants to receive. The transfer happens + through the passed file descriptor (typically created with the pipe + system call). The source client writes the data in the MIME type + representation requested and then closes the file descriptor. + + The receiving client reads from the read end of the pipe until EOF and + then closes its end, at which point the transfer is complete. + + This request may happen multiple times for different MIME types. + </description> + <arg name="mime_type" type="string" + summary="MIME type desired by receiver"/> + <arg name="fd" type="fd" summary="file descriptor for data transfer"/> + </request> + + <request name="destroy" type="destructor"> + <description summary="destroy this offer"> + Destroys the data offer object. + </description> + </request> + + <event name="offer"> + <description summary="advertise offered MIME type"> + Sent immediately after creating the wlr_data_control_offer object. + One event per offered MIME type. + </description> + <arg name="mime_type" type="string" summary="offered MIME type"/> + </event> + </interface> +</protocol> diff --git a/Sources/Protocol/xdg-shell-unstable-v6.xml b/Sources/Protocol/xdg-shell-unstable-v6.xml new file mode 100644 index 0000000..1c0f924 --- /dev/null +++ b/Sources/Protocol/xdg-shell-unstable-v6.xml @@ -0,0 +1,1044 @@ +<?xml version="1.0" encoding="UTF-8"?> +<protocol name="xdg_shell_unstable_v6"> + + <copyright> + Copyright © 2008-2013 Kristian Høgsberg + Copyright © 2013 Rafael Antognolli + Copyright © 2013 Jasper St. Pierre + Copyright © 2010-2013 Intel Corporation + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + </copyright> + + <interface name="zxdg_shell_v6" version="1"> + <description summary="create desktop-style surfaces"> + xdg_shell allows clients to turn a wl_surface into a "real window" + which can be dragged, resized, stacked, and moved around by the + user. Everything about this interface is suited towards traditional + desktop environments. + </description> + + <enum name="error"> + <entry name="role" value="0" summary="given wl_surface has another role"/> + <entry name="defunct_surfaces" value="1" + summary="xdg_shell was destroyed before children"/> + <entry name="not_the_topmost_popup" value="2" + summary="the client tried to map or destroy a non-topmost popup"/> + <entry name="invalid_popup_parent" value="3" + summary="the client specified an invalid popup parent surface"/> + <entry name="invalid_surface_state" value="4" + summary="the client provided an invalid surface state"/> + <entry name="invalid_positioner" value="5" + summary="the client provided an invalid positioner"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="destroy xdg_shell"> + Destroy this xdg_shell object. + + Destroying a bound xdg_shell object while there are surfaces + still alive created by this xdg_shell object instance is illegal + and will result in a protocol error. + </description> + </request> + + <request name="create_positioner"> + <description summary="create a positioner object"> + Create a positioner object. A positioner object is used to position + surfaces relative to some parent surface. See the interface description + and xdg_surface.get_popup for details. + </description> + <arg name="id" type="new_id" interface="zxdg_positioner_v6"/> + </request> + + <request name="get_xdg_surface"> + <description summary="create a shell surface from a surface"> + This creates an xdg_surface for the given surface. While xdg_surface + itself is not a role, the corresponding surface may only be assigned + a role extending xdg_surface, such as xdg_toplevel or xdg_popup. + + This creates an xdg_surface for the given surface. An xdg_surface is + used as basis to define a role to a given surface, such as xdg_toplevel + or xdg_popup. It also manages functionality shared between xdg_surface + based surface roles. + + See the documentation of xdg_surface for more details about what an + xdg_surface is and how it is used. + </description> + <arg name="id" type="new_id" interface="zxdg_surface_v6"/> + <arg name="surface" type="object" interface="wl_surface"/> + </request> + + <request name="pong"> + <description summary="respond to a ping event"> + A client must respond to a ping event with a pong request or + the client may be deemed unresponsive. See xdg_shell.ping. + </description> + <arg name="serial" type="uint" summary="serial of the ping event"/> + </request> + + <event name="ping"> + <description summary="check if the client is alive"> + The ping event asks the client if it's still alive. Pass the + serial specified in the event back to the compositor by sending + a "pong" request back with the specified serial. See xdg_shell.ping. + + Compositors can use this to determine if the client is still + alive. It's unspecified what will happen if the client doesn't + respond to the ping request, or in what timeframe. Clients should + try to respond in a reasonable amount of time. + + A compositor is free to ping in any way it wants, but a client must + always respond to any xdg_shell object it created. + </description> + <arg name="serial" type="uint" summary="pass this to the pong request"/> + </event> + </interface> + + <interface name="zxdg_positioner_v6" version="1"> + <description summary="child surface positioner"> + The xdg_positioner provides a collection of rules for the placement of a + child surface relative to a parent surface. Rules can be defined to ensure + the child surface remains within the visible area's borders, and to + specify how the child surface changes its position, such as sliding along + an axis, or flipping around a rectangle. These positioner-created rules are + constrained by the requirement that a child surface must intersect with or + be at least partially adjacent to its parent surface. + + See the various requests for details about possible rules. + + At the time of the request, the compositor makes a copy of the rules + specified by the xdg_positioner. Thus, after the request is complete the + xdg_positioner object can be destroyed or reused; further changes to the + object will have no effect on previous usages. + + For an xdg_positioner object to be considered complete, it must have a + non-zero size set by set_size, and a non-zero anchor rectangle set by + set_anchor_rect. Passing an incomplete xdg_positioner object when + positioning a surface raises an error. + </description> + + <enum name="error"> + <entry name="invalid_input" value="0" summary="invalid input provided"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="destroy the xdg_positioner object"> + Notify the compositor that the xdg_positioner will no longer be used. + </description> + </request> + + <request name="set_size"> + <description summary="set the size of the to-be positioned rectangle"> + Set the size of the surface that is to be positioned with the positioner + object. The size is in surface-local coordinates and corresponds to the + window geometry. See xdg_surface.set_window_geometry. + + If a zero or negative size is set the invalid_input error is raised. + </description> + <arg name="width" type="int" summary="width of positioned rectangle"/> + <arg name="height" type="int" summary="height of positioned rectangle"/> + </request> + + <request name="set_anchor_rect"> + <description summary="set the anchor rectangle within the parent surface"> + Specify the anchor rectangle within the parent surface that the child + surface will be placed relative to. The rectangle is relative to the + window geometry as defined by xdg_surface.set_window_geometry of the + parent surface. The rectangle must be at least 1x1 large. + + When the xdg_positioner object is used to position a child surface, the + anchor rectangle may not extend outside the window geometry of the + positioned child's parent surface. + + If a zero or negative size is set the invalid_input error is raised. + </description> + <arg name="x" type="int" summary="x position of anchor rectangle"/> + <arg name="y" type="int" summary="y position of anchor rectangle"/> + <arg name="width" type="int" summary="width of anchor rectangle"/> + <arg name="height" type="int" summary="height of anchor rectangle"/> + </request> + + <enum name="anchor" bitfield="true"> + <entry name="none" value="0" + summary="the center of the anchor rectangle"/> + <entry name="top" value="1" + summary="the top edge of the anchor rectangle"/> + <entry name="bottom" value="2" + summary="the bottom edge of the anchor rectangle"/> + <entry name="left" value="4" + summary="the left edge of the anchor rectangle"/> + <entry name="right" value="8" + summary="the right edge of the anchor rectangle"/> + </enum> + + <request name="set_anchor"> + <description summary="set anchor rectangle anchor edges"> + Defines a set of edges for the anchor rectangle. These are used to + derive an anchor point that the child surface will be positioned + relative to. If two orthogonal edges are specified (e.g. 'top' and + 'left'), then the anchor point will be the intersection of the edges + (e.g. the top left position of the rectangle); otherwise, the derived + anchor point will be centered on the specified edge, or in the center of + the anchor rectangle if no edge is specified. + + If two parallel anchor edges are specified (e.g. 'left' and 'right'), + the invalid_input error is raised. + </description> + <arg name="anchor" type="uint" enum="anchor" + summary="bit mask of anchor edges"/> + </request> + + <enum name="gravity" bitfield="true"> + <entry name="none" value="0" + summary="center over the anchor edge"/> + <entry name="top" value="1" + summary="position above the anchor edge"/> + <entry name="bottom" value="2" + summary="position below the anchor edge"/> + <entry name="left" value="4" + summary="position to the left of the anchor edge"/> + <entry name="right" value="8" + summary="position to the right of the anchor edge"/> + </enum> + + <request name="set_gravity"> + <description summary="set child surface gravity"> + Defines in what direction a surface should be positioned, relative to + the anchor point of the parent surface. If two orthogonal gravities are + specified (e.g. 'bottom' and 'right'), then the child surface will be + placed in the specified direction; otherwise, the child surface will be + centered over the anchor point on any axis that had no gravity + specified. + + If two parallel gravities are specified (e.g. 'left' and 'right'), the + invalid_input error is raised. + </description> + <arg name="gravity" type="uint" enum="gravity" + summary="bit mask of gravity directions"/> + </request> + + <enum name="constraint_adjustment" bitfield="true"> + <description summary="constraint adjustments"> + The constraint adjustment value define ways the compositor will adjust + the position of the surface, if the unadjusted position would result + in the surface being partly constrained. + + Whether a surface is considered 'constrained' is left to the compositor + to determine. For example, the surface may be partly outside the + compositor's defined 'work area', thus necessitating the child surface's + position be adjusted until it is entirely inside the work area. + + The adjustments can be combined, according to a defined precedence: 1) + Flip, 2) Slide, 3) Resize. + </description> + <entry name="none" value="0"> + <description summary="don't move the child surface when constrained"> + Don't alter the surface position even if it is constrained on some + axis, for example partially outside the edge of a monitor. + </description> + </entry> + <entry name="slide_x" value="1"> + <description summary="move along the x axis until unconstrained"> + Slide the surface along the x axis until it is no longer constrained. + + First try to slide towards the direction of the gravity on the x axis + until either the edge in the opposite direction of the gravity is + unconstrained or the edge in the direction of the gravity is + constrained. + + Then try to slide towards the opposite direction of the gravity on the + x axis until either the edge in the direction of the gravity is + unconstrained or the edge in the opposite direction of the gravity is + constrained. + </description> + </entry> + <entry name="slide_y" value="2"> + <description summary="move along the y axis until unconstrained"> + Slide the surface along the y axis until it is no longer constrained. + + First try to slide towards the direction of the gravity on the y axis + until either the edge in the opposite direction of the gravity is + unconstrained or the edge in the direction of the gravity is + constrained. + + Then try to slide towards the opposite direction of the gravity on the + y axis until either the edge in the direction of the gravity is + unconstrained or the edge in the opposite direction of the gravity is + constrained. + </description> + </entry> + <entry name="flip_x" value="4"> + <description summary="invert the anchor and gravity on the x axis"> + Invert the anchor and gravity on the x axis if the surface is + constrained on the x axis. For example, if the left edge of the + surface is constrained, the gravity is 'left' and the anchor is + 'left', change the gravity to 'right' and the anchor to 'right'. + + If the adjusted position also ends up being constrained, the resulting + position of the flip_x adjustment will be the one before the + adjustment. + </description> + </entry> + <entry name="flip_y" value="8"> + <description summary="invert the anchor and gravity on the y axis"> + Invert the anchor and gravity on the y axis if the surface is + constrained on the y axis. For example, if the bottom edge of the + surface is constrained, the gravity is 'bottom' and the anchor is + 'bottom', change the gravity to 'top' and the anchor to 'top'. + + If the adjusted position also ends up being constrained, the resulting + position of the flip_y adjustment will be the one before the + adjustment. + </description> + </entry> + <entry name="resize_x" value="16"> + <description summary="horizontally resize the surface"> + Resize the surface horizontally so that it is completely + unconstrained. + </description> + </entry> + <entry name="resize_y" value="32"> + <description summary="vertically resize the surface"> + Resize the surface vertically so that it is completely unconstrained. + </description> + </entry> + </enum> + + <request name="set_constraint_adjustment"> + <description summary="set the adjustment to be done when constrained"> + Specify how the window should be positioned if the originally intended + position caused the surface to be constrained, meaning at least + partially outside positioning boundaries set by the compositor. The + adjustment is set by constructing a bitmask describing the adjustment to + be made when the surface is constrained on that axis. + + If no bit for one axis is set, the compositor will assume that the child + surface should not change its position on that axis when constrained. + + If more than one bit for one axis is set, the order of how adjustments + are applied is specified in the corresponding adjustment descriptions. + + The default adjustment is none. + </description> + <arg name="constraint_adjustment" type="uint" + summary="bit mask of constraint adjustments"/> + </request> + + <request name="set_offset"> + <description summary="set surface position offset"> + Specify the surface position offset relative to the position of the + anchor on the anchor rectangle and the anchor on the surface. For + example if the anchor of the anchor rectangle is at (x, y), the surface + has the gravity bottom|right, and the offset is (ox, oy), the calculated + surface position will be (x + ox, y + oy). The offset position of the + surface is the one used for constraint testing. See + set_constraint_adjustment. + + An example use case is placing a popup menu on top of a user interface + element, while aligning the user interface element of the parent surface + with some user interface element placed somewhere in the popup surface. + </description> + <arg name="x" type="int" summary="surface position x offset"/> + <arg name="y" type="int" summary="surface position y offset"/> + </request> + </interface> + + <interface name="zxdg_surface_v6" version="1"> + <description summary="desktop user interface surface base interface"> + An interface that may be implemented by a wl_surface, for + implementations that provide a desktop-style user interface. + + It provides a base set of functionality required to construct user + interface elements requiring management by the compositor, such as + toplevel windows, menus, etc. The types of functionality are split into + xdg_surface roles. + + Creating an xdg_surface does not set the role for a wl_surface. In order + to map an xdg_surface, the client must create a role-specific object + using, e.g., get_toplevel, get_popup. The wl_surface for any given + xdg_surface can have at most one role, and may not be assigned any role + not based on xdg_surface. + + A role must be assigned before any other requests are made to the + xdg_surface object. + + The client must call wl_surface.commit on the corresponding wl_surface + for the xdg_surface state to take effect. + + Creating an xdg_surface from a wl_surface which has a buffer attached or + committed is a client error, and any attempts by a client to attach or + manipulate a buffer prior to the first xdg_surface.configure call must + also be treated as errors. + + For a surface to be mapped by the compositor, the following conditions + must be met: (1) the client has assigned a xdg_surface based role to the + surface, (2) the client has set and committed the xdg_surface state and + the role dependent state to the surface and (3) the client has committed a + buffer to the surface. + </description> + + <enum name="error"> + <entry name="not_constructed" value="1"/> + <entry name="already_constructed" value="2"/> + <entry name="unconfigured_buffer" value="3"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="destroy the xdg_surface"> + Destroy the xdg_surface object. An xdg_surface must only be destroyed + after its role object has been destroyed. + </description> + </request> + + <request name="get_toplevel"> + <description summary="assign the xdg_toplevel surface role"> + This creates an xdg_toplevel object for the given xdg_surface and gives + the associated wl_surface the xdg_toplevel role. + + See the documentation of xdg_toplevel for more details about what an + xdg_toplevel is and how it is used. + </description> + <arg name="id" type="new_id" interface="zxdg_toplevel_v6"/> + </request> + + <request name="get_popup"> + <description summary="assign the xdg_popup surface role"> + This creates an xdg_popup object for the given xdg_surface and gives the + associated wl_surface the xdg_popup role. + + See the documentation of xdg_popup for more details about what an + xdg_popup is and how it is used. + </description> + <arg name="id" type="new_id" interface="zxdg_popup_v6"/> + <arg name="parent" type="object" interface="zxdg_surface_v6"/> + <arg name="positioner" type="object" interface="zxdg_positioner_v6"/> + </request> + + <request name="set_window_geometry"> + <description summary="set the new window geometry"> + The window geometry of a surface is its "visible bounds" from the + user's perspective. Client-side decorations often have invisible + portions like drop-shadows which should be ignored for the + purposes of aligning, placing and constraining windows. + + The window geometry is double buffered, and will be applied at the + time wl_surface.commit of the corresponding wl_surface is called. + + Once the window geometry of the surface is set, it is not possible to + unset it, and it will remain the same until set_window_geometry is + called again, even if a new subsurface or buffer is attached. + + If never set, the value is the full bounds of the surface, + including any subsurfaces. This updates dynamically on every + commit. This unset is meant for extremely simple clients. + + The arguments are given in the surface-local coordinate space of + the wl_surface associated with this xdg_surface. + + The width and height must be greater than zero. Setting an invalid size + will raise an error. When applied, the effective window geometry will be + the set window geometry clamped to the bounding rectangle of the + combined geometry of the surface of the xdg_surface and the associated + subsurfaces. + </description> + <arg name="x" type="int"/> + <arg name="y" type="int"/> + <arg name="width" type="int"/> + <arg name="height" type="int"/> + </request> + + <request name="ack_configure"> + <description summary="ack a configure event"> + When a configure event is received, if a client commits the + surface in response to the configure event, then the client + must make an ack_configure request sometime before the commit + request, passing along the serial of the configure event. + + For instance, for toplevel surfaces the compositor might use this + information to move a surface to the top left only when the client has + drawn itself for the maximized or fullscreen state. + + If the client receives multiple configure events before it + can respond to one, it only has to ack the last configure event. + + A client is not required to commit immediately after sending + an ack_configure request - it may even ack_configure several times + before its next surface commit. + + A client may send multiple ack_configure requests before committing, but + only the last request sent before a commit indicates which configure + event the client really is responding to. + </description> + <arg name="serial" type="uint" summary="the serial from the configure event"/> + </request> + + <event name="configure"> + <description summary="suggest a surface change"> + The configure event marks the end of a configure sequence. A configure + sequence is a set of one or more events configuring the state of the + xdg_surface, including the final xdg_surface.configure event. + + Where applicable, xdg_surface surface roles will during a configure + sequence extend this event as a latched state sent as events before the + xdg_surface.configure event. Such events should be considered to make up + a set of atomically applied configuration states, where the + xdg_surface.configure commits the accumulated state. + + Clients should arrange their surface for the new states, and then send + an ack_configure request with the serial sent in this configure event at + some point before committing the new surface. + + If the client receives multiple configure events before it can respond + to one, it is free to discard all but the last event it received. + </description> + <arg name="serial" type="uint" summary="serial of the configure event"/> + </event> + </interface> + + <interface name="zxdg_toplevel_v6" version="1"> + <description summary="toplevel surface"> + This interface defines an xdg_surface role which allows a surface to, + among other things, set window-like properties such as maximize, + fullscreen, and minimize, set application-specific metadata like title and + id, and well as trigger user interactive operations such as interactive + resize and move. + </description> + + <request name="destroy" type="destructor"> + <description summary="destroy the xdg_toplevel"> + Unmap and destroy the window. The window will be effectively + hidden from the user's point of view, and all state like + maximization, fullscreen, and so on, will be lost. + </description> + </request> + + <request name="set_parent"> + <description summary="set the parent of this surface"> + Set the "parent" of this surface. This window should be stacked + above a parent. The parent surface must be mapped as long as this + surface is mapped. + + Parent windows should be set on dialogs, toolboxes, or other + "auxiliary" surfaces, so that the parent is raised when the dialog + is raised. + </description> + <arg name="parent" type="object" interface="zxdg_toplevel_v6" allow-null="true"/> + </request> + + <request name="set_title"> + <description summary="set surface title"> + Set a short title for the surface. + + This string may be used to identify the surface in a task bar, + window list, or other user interface elements provided by the + compositor. + + The string must be encoded in UTF-8. + </description> + <arg name="title" type="string"/> + </request> + + <request name="set_app_id"> + <description summary="set application ID"> + Set an application identifier for the surface. + + The app ID identifies the general class of applications to which + the surface belongs. The compositor can use this to group multiple + surfaces together, or to determine how to launch a new application. + + For D-Bus activatable applications, the app ID is used as the D-Bus + service name. + + The compositor shell will try to group application surfaces together + by their app ID. As a best practice, it is suggested to select app + ID's that match the basename of the application's .desktop file. + For example, "org.freedesktop.FooViewer" where the .desktop file is + "org.freedesktop.FooViewer.desktop". + + See the desktop-entry specification [0] for more details on + application identifiers and how they relate to well-known D-Bus + names and .desktop files. + + [0] http://standards.freedesktop.org/desktop-entry-spec/ + </description> + <arg name="app_id" type="string"/> + </request> + + <request name="show_window_menu"> + <description summary="show the window menu"> + Clients implementing client-side decorations might want to show + a context menu when right-clicking on the decorations, giving the + user a menu that they can use to maximize or minimize the window. + + This request asks the compositor to pop up such a window menu at + the given position, relative to the local surface coordinates of + the parent surface. There are no guarantees as to what menu items + the window menu contains. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. + </description> + <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/> + <arg name="serial" type="uint" summary="the serial of the user event"/> + <arg name="x" type="int" summary="the x position to pop up the window menu at"/> + <arg name="y" type="int" summary="the y position to pop up the window menu at"/> + </request> + + <request name="move"> + <description summary="start an interactive move"> + Start an interactive, user-driven move of the surface. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. The passed + serial is used to determine the type of interactive move (touch, + pointer, etc). + + The server may ignore move requests depending on the state of + the surface (e.g. fullscreen or maximized), or if the passed serial + is no longer valid. + + If triggered, the surface will lose the focus of the device + (wl_pointer, wl_touch, etc) used for the move. It is up to the + compositor to visually indicate that the move is taking place, such as + updating a pointer cursor, during the move. There is no guarantee + that the device focus will return when the move is completed. + </description> + <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/> + <arg name="serial" type="uint" summary="the serial of the user event"/> + </request> + + <enum name="resize_edge"> + <description summary="edge values for resizing"> + These values are used to indicate which edge of a surface + is being dragged in a resize operation. + </description> + <entry name="none" value="0"/> + <entry name="top" value="1"/> + <entry name="bottom" value="2"/> + <entry name="left" value="4"/> + <entry name="top_left" value="5"/> + <entry name="bottom_left" value="6"/> + <entry name="right" value="8"/> + <entry name="top_right" value="9"/> + <entry name="bottom_right" value="10"/> + </enum> + + <request name="resize"> + <description summary="start an interactive resize"> + Start a user-driven, interactive resize of the surface. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. The passed + serial is used to determine the type of interactive resize (touch, + pointer, etc). + + The server may ignore resize requests depending on the state of + the surface (e.g. fullscreen or maximized). + + If triggered, the client will receive configure events with the + "resize" state enum value and the expected sizes. See the "resize" + enum value for more details about what is required. The client + must also acknowledge configure events using "ack_configure". After + the resize is completed, the client will receive another "configure" + event without the resize state. + + If triggered, the surface also will lose the focus of the device + (wl_pointer, wl_touch, etc) used for the resize. It is up to the + compositor to visually indicate that the resize is taking place, + such as updating a pointer cursor, during the resize. There is no + guarantee that the device focus will return when the resize is + completed. + + The edges parameter specifies how the surface should be resized, + and is one of the values of the resize_edge enum. The compositor + may use this information to update the surface position for + example when dragging the top left corner. The compositor may also + use this information to adapt its behavior, e.g. choose an + appropriate cursor image. + </description> + <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/> + <arg name="serial" type="uint" summary="the serial of the user event"/> + <arg name="edges" type="uint" summary="which edge or corner is being dragged"/> + </request> + + <enum name="state"> + <description summary="types of state on the surface"> + The different state values used on the surface. This is designed for + state values like maximized, fullscreen. It is paired with the + configure event to ensure that both the client and the compositor + setting the state can be synchronized. + + States set in this way are double-buffered. They will get applied on + the next commit. + </description> + <entry name="maximized" value="1" summary="the surface is maximized"> + <description summary="the surface is maximized"> + The surface is maximized. The window geometry specified in the configure + event must be obeyed by the client. + </description> + </entry> + <entry name="fullscreen" value="2" summary="the surface is fullscreen"> + <description summary="the surface is fullscreen"> + The surface is fullscreen. The window geometry specified in the configure + event must be obeyed by the client. + </description> + </entry> + <entry name="resizing" value="3" summary="the surface is being resized"> + <description summary="the surface is being resized"> + The surface is being resized. The window geometry specified in the + configure event is a maximum; the client cannot resize beyond it. + Clients that have aspect ratio or cell sizing configuration can use + a smaller size, however. + </description> + </entry> + <entry name="activated" value="4" summary="the surface is now activated"> + <description summary="the surface is now activated"> + Client window decorations should be painted as if the window is + active. Do not assume this means that the window actually has + keyboard or pointer focus. + </description> + </entry> + </enum> + + <request name="set_max_size"> + <description summary="set the maximum size"> + Set a maximum size for the window. + + The client can specify a maximum size so that the compositor does + not try to configure the window beyond this size. + + The width and height arguments are in window geometry coordinates. + See xdg_surface.set_window_geometry. + + Values set in this way are double-buffered. They will get applied + on the next commit. + + The compositor can use this information to allow or disallow + different states like maximize or fullscreen and draw accurate + animations. + + Similarly, a tiling window manager may use this information to + place and resize client windows in a more effective way. + + The client should not rely on the compositor to obey the maximum + size. The compositor may decide to ignore the values set by the + client and request a larger size. + + If never set, or a value of zero in the request, means that the + client has no expected maximum size in the given dimension. + As a result, a client wishing to reset the maximum size + to an unspecified state can use zero for width and height in the + request. + + Requesting a maximum size to be smaller than the minimum size of + a surface is illegal and will result in a protocol error. + + The width and height must be greater than or equal to zero. Using + strictly negative values for width and height will result in a + protocol error. + </description> + <arg name="width" type="int"/> + <arg name="height" type="int"/> + </request> + + <request name="set_min_size"> + <description summary="set the minimum size"> + Set a minimum size for the window. + + The client can specify a minimum size so that the compositor does + not try to configure the window below this size. + + The width and height arguments are in window geometry coordinates. + See xdg_surface.set_window_geometry. + + Values set in this way are double-buffered. They will get applied + on the next commit. + + The compositor can use this information to allow or disallow + different states like maximize or fullscreen and draw accurate + animations. + + Similarly, a tiling window manager may use this information to + place and resize client windows in a more effective way. + + The client should not rely on the compositor to obey the minimum + size. The compositor may decide to ignore the values set by the + client and request a smaller size. + + If never set, or a value of zero in the request, means that the + client has no expected minimum size in the given dimension. + As a result, a client wishing to reset the minimum size + to an unspecified state can use zero for width and height in the + request. + + Requesting a minimum size to be larger than the maximum size of + a surface is illegal and will result in a protocol error. + + The width and height must be greater than or equal to zero. Using + strictly negative values for width and height will result in a + protocol error. + </description> + <arg name="width" type="int"/> + <arg name="height" type="int"/> + </request> + + <request name="set_maximized"> + <description summary="maximize the window"> + Maximize the surface. + + After requesting that the surface should be maximized, the compositor + will respond by emitting a configure event with the "maximized" state + and the required window geometry. The client should then update its + content, drawing it in a maximized state, i.e. without shadow or other + decoration outside of the window geometry. The client must also + acknowledge the configure when committing the new content (see + ack_configure). + + It is up to the compositor to decide how and where to maximize the + surface, for example which output and what region of the screen should + be used. + + If the surface was already maximized, the compositor will still emit + a configure event with the "maximized" state. + </description> + </request> + + <request name="unset_maximized"> + <description summary="unmaximize the window"> + Unmaximize the surface. + + After requesting that the surface should be unmaximized, the compositor + will respond by emitting a configure event without the "maximized" + state. If available, the compositor will include the window geometry + dimensions the window had prior to being maximized in the configure + request. The client must then update its content, drawing it in a + regular state, i.e. potentially with shadow, etc. The client must also + acknowledge the configure when committing the new content (see + ack_configure). + + It is up to the compositor to position the surface after it was + unmaximized; usually the position the surface had before maximizing, if + applicable. + + If the surface was already not maximized, the compositor will still + emit a configure event without the "maximized" state. + </description> + </request> + + <request name="set_fullscreen"> + <description summary="set the window as fullscreen on a monitor"> + Make the surface fullscreen. + + You can specify an output that you would prefer to be fullscreen. + If this value is NULL, it's up to the compositor to choose which + display will be used to map this surface. + + If the surface doesn't cover the whole output, the compositor will + position the surface in the center of the output and compensate with + black borders filling the rest of the output. + </description> + <arg name="output" type="object" interface="wl_output" allow-null="true"/> + </request> + <request name="unset_fullscreen" /> + + <request name="set_minimized"> + <description summary="set the window as minimized"> + Request that the compositor minimize your surface. There is no + way to know if the surface is currently minimized, nor is there + any way to unset minimization on this surface. + + If you are looking to throttle redrawing when minimized, please + instead use the wl_surface.frame event for this, as this will + also work with live previews on windows in Alt-Tab, Expose or + similar compositor features. + </description> + </request> + + <event name="configure"> + <description summary="suggest a surface change"> + This configure event asks the client to resize its toplevel surface or + to change its state. The configured state should not be applied + immediately. See xdg_surface.configure for details. + + The width and height arguments specify a hint to the window + about how its surface should be resized in window geometry + coordinates. See set_window_geometry. + + If the width or height arguments are zero, it means the client + should decide its own window dimension. This may happen when the + compositor needs to configure the state of the surface but doesn't + have any information about any previous or expected dimension. + + The states listed in the event specify how the width/height + arguments should be interpreted, and possibly how it should be + drawn. + + Clients must send an ack_configure in response to this event. See + xdg_surface.configure and xdg_surface.ack_configure for details. + </description> + <arg name="width" type="int"/> + <arg name="height" type="int"/> + <arg name="states" type="array"/> + </event> + + <event name="close"> + <description summary="surface wants to be closed"> + The close event is sent by the compositor when the user + wants the surface to be closed. This should be equivalent to + the user clicking the close button in client-side decorations, + if your application has any. + + This is only a request that the user intends to close the + window. The client may choose to ignore this request, or show + a dialog to ask the user to save their data, etc. + </description> + </event> + </interface> + + <interface name="zxdg_popup_v6" version="1"> + <description summary="short-lived, popup surfaces for menus"> + A popup surface is a short-lived, temporary surface. It can be used to + implement for example menus, popovers, tooltips and other similar user + interface concepts. + + A popup can be made to take an explicit grab. See xdg_popup.grab for + details. + + When the popup is dismissed, a popup_done event will be sent out, and at + the same time the surface will be unmapped. See the xdg_popup.popup_done + event for details. + + Explicitly destroying the xdg_popup object will also dismiss the popup and + unmap the surface. Clients that want to dismiss the popup when another + surface of their own is clicked should dismiss the popup using the destroy + request. + + The parent surface must have either the xdg_toplevel or xdg_popup surface + role. + + A newly created xdg_popup will be stacked on top of all previously created + xdg_popup surfaces associated with the same xdg_toplevel. + + The parent of an xdg_popup must be mapped (see the xdg_surface + description) before the xdg_popup itself. + + The x and y arguments passed when creating the popup object specify + where the top left of the popup should be placed, relative to the + local surface coordinates of the parent surface. See + xdg_surface.get_popup. An xdg_popup must intersect with or be at least + partially adjacent to its parent surface. + + The client must call wl_surface.commit on the corresponding wl_surface + for the xdg_popup state to take effect. + </description> + + <enum name="error"> + <entry name="invalid_grab" value="0" + summary="tried to grab after being mapped"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="remove xdg_popup interface"> + This destroys the popup. Explicitly destroying the xdg_popup + object will also dismiss the popup, and unmap the surface. + + If this xdg_popup is not the "topmost" popup, a protocol error + will be sent. + </description> + </request> + + <request name="grab"> + <description summary="make the popup take an explicit grab"> + This request makes the created popup take an explicit grab. An explicit + grab will be dismissed when the user dismisses the popup, or when the + client destroys the xdg_popup. This can be done by the user clicking + outside the surface, using the keyboard, or even locking the screen + through closing the lid or a timeout. + + If the compositor denies the grab, the popup will be immediately + dismissed. + + This request must be used in response to some sort of user action like a + button press, key press, or touch down event. The serial number of the + event should be passed as 'serial'. + + The parent of a grabbing popup must either be an xdg_toplevel surface or + another xdg_popup with an explicit grab. If the parent is another + xdg_popup it means that the popups are nested, with this popup now being + the topmost popup. + + Nested popups must be destroyed in the reverse order they were created + in, e.g. the only popup you are allowed to destroy at all times is the + topmost one. + + When compositors choose to dismiss a popup, they may dismiss every + nested grabbing popup as well. When a compositor dismisses popups, it + will follow the same dismissing order as required from the client. + + The parent of a grabbing popup must either be another xdg_popup with an + active explicit grab, or an xdg_popup or xdg_toplevel, if there are no + explicit grabs already taken. + + If the topmost grabbing popup is destroyed, the grab will be returned to + the parent of the popup, if that parent previously had an explicit grab. + + If the parent is a grabbing popup which has already been dismissed, this + popup will be immediately dismissed. If the parent is a popup that did + not take an explicit grab, an error will be raised. + + During a popup grab, the client owning the grab will receive pointer + and touch events for all their surfaces as normal (similar to an + "owner-events" grab in X11 parlance), while the top most grabbing popup + will always have keyboard focus. + </description> + <arg name="seat" type="object" interface="wl_seat" + summary="the wl_seat of the user event"/> + <arg name="serial" type="uint" summary="the serial of the user event"/> + </request> + + <event name="configure"> + <description summary="configure the popup surface"> + This event asks the popup surface to configure itself given the + configuration. The configured state should not be applied immediately. + See xdg_surface.configure for details. + + The x and y arguments represent the position the popup was placed at + given the xdg_positioner rule, relative to the upper left corner of the + window geometry of the parent surface. + </description> + <arg name="x" type="int" + summary="x position relative to parent surface window geometry"/> + <arg name="y" type="int" + summary="y position relative to parent surface window geometry"/> + <arg name="width" type="int" summary="window geometry width"/> + <arg name="height" type="int" summary="window geometry height"/> + </event> + + <event name="popup_done"> + <description summary="popup interaction is done"> + The popup_done event is sent out when a popup is dismissed by the + compositor. The client should destroy the xdg_popup object at this + point. + </description> + </event> + + </interface> +</protocol> diff --git a/Sources/Protocol/xdg-shell.xml b/Sources/Protocol/xdg-shell.xml new file mode 100644 index 0000000..364d130 --- /dev/null +++ b/Sources/Protocol/xdg-shell.xml @@ -0,0 +1,1251 @@ +<?xml version="1.0" encoding="UTF-8"?> +<protocol name="xdg_shell"> + + <copyright> + Copyright © 2008-2013 Kristian Høgsberg + Copyright © 2013 Rafael Antognolli + Copyright © 2013 Jasper St. Pierre + Copyright © 2010-2013 Intel Corporation + Copyright © 2015-2017 Samsung Electronics Co., Ltd + Copyright © 2015-2017 Red Hat Inc. + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + </copyright> + + <interface name="xdg_wm_base" version="3"> + <description summary="create desktop-style surfaces"> + The xdg_wm_base interface is exposed as a global object enabling clients + to turn their wl_surfaces into windows in a desktop environment. It + defines the basic functionality needed for clients and the compositor to + create windows that can be dragged, resized, maximized, etc, as well as + creating transient windows such as popup menus. + </description> + + <enum name="error"> + <entry name="role" value="0" summary="given wl_surface has another role"/> + <entry name="defunct_surfaces" value="1" + summary="xdg_wm_base was destroyed before children"/> + <entry name="not_the_topmost_popup" value="2" + summary="the client tried to map or destroy a non-topmost popup"/> + <entry name="invalid_popup_parent" value="3" + summary="the client specified an invalid popup parent surface"/> + <entry name="invalid_surface_state" value="4" + summary="the client provided an invalid surface state"/> + <entry name="invalid_positioner" value="5" + summary="the client provided an invalid positioner"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="destroy xdg_wm_base"> + Destroy this xdg_wm_base object. + + Destroying a bound xdg_wm_base object while there are surfaces + still alive created by this xdg_wm_base object instance is illegal + and will result in a protocol error. + </description> + </request> + + <request name="create_positioner"> + <description summary="create a positioner object"> + Create a positioner object. A positioner object is used to position + surfaces relative to some parent surface. See the interface description + and xdg_surface.get_popup for details. + </description> + <arg name="id" type="new_id" interface="xdg_positioner"/> + </request> + + <request name="get_xdg_surface"> + <description summary="create a shell surface from a surface"> + This creates an xdg_surface for the given surface. While xdg_surface + itself is not a role, the corresponding surface may only be assigned + a role extending xdg_surface, such as xdg_toplevel or xdg_popup. It is + illegal to create an xdg_surface for a wl_surface which already has an + assigned role and this will result in a protocol error. + + This creates an xdg_surface for the given surface. An xdg_surface is + used as basis to define a role to a given surface, such as xdg_toplevel + or xdg_popup. It also manages functionality shared between xdg_surface + based surface roles. + + See the documentation of xdg_surface for more details about what an + xdg_surface is and how it is used. + </description> + <arg name="id" type="new_id" interface="xdg_surface"/> + <arg name="surface" type="object" interface="wl_surface"/> + </request> + + <request name="pong"> + <description summary="respond to a ping event"> + A client must respond to a ping event with a pong request or + the client may be deemed unresponsive. See xdg_wm_base.ping. + </description> + <arg name="serial" type="uint" summary="serial of the ping event"/> + </request> + + <event name="ping"> + <description summary="check if the client is alive"> + The ping event asks the client if it's still alive. Pass the + serial specified in the event back to the compositor by sending + a "pong" request back with the specified serial. See xdg_wm_base.pong. + + Compositors can use this to determine if the client is still + alive. It's unspecified what will happen if the client doesn't + respond to the ping request, or in what timeframe. Clients should + try to respond in a reasonable amount of time. + + A compositor is free to ping in any way it wants, but a client must + always respond to any xdg_wm_base object it created. + </description> + <arg name="serial" type="uint" summary="pass this to the pong request"/> + </event> + </interface> + + <interface name="xdg_positioner" version="3"> + <description summary="child surface positioner"> + The xdg_positioner provides a collection of rules for the placement of a + child surface relative to a parent surface. Rules can be defined to ensure + the child surface remains within the visible area's borders, and to + specify how the child surface changes its position, such as sliding along + an axis, or flipping around a rectangle. These positioner-created rules are + constrained by the requirement that a child surface must intersect with or + be at least partially adjacent to its parent surface. + + See the various requests for details about possible rules. + + At the time of the request, the compositor makes a copy of the rules + specified by the xdg_positioner. Thus, after the request is complete the + xdg_positioner object can be destroyed or reused; further changes to the + object will have no effect on previous usages. + + For an xdg_positioner object to be considered complete, it must have a + non-zero size set by set_size, and a non-zero anchor rectangle set by + set_anchor_rect. Passing an incomplete xdg_positioner object when + positioning a surface raises an error. + </description> + + <enum name="error"> + <entry name="invalid_input" value="0" summary="invalid input provided"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="destroy the xdg_positioner object"> + Notify the compositor that the xdg_positioner will no longer be used. + </description> + </request> + + <request name="set_size"> + <description summary="set the size of the to-be positioned rectangle"> + Set the size of the surface that is to be positioned with the positioner + object. The size is in surface-local coordinates and corresponds to the + window geometry. See xdg_surface.set_window_geometry. + + If a zero or negative size is set the invalid_input error is raised. + </description> + <arg name="width" type="int" summary="width of positioned rectangle"/> + <arg name="height" type="int" summary="height of positioned rectangle"/> + </request> + + <request name="set_anchor_rect"> + <description summary="set the anchor rectangle within the parent surface"> + Specify the anchor rectangle within the parent surface that the child + surface will be placed relative to. The rectangle is relative to the + window geometry as defined by xdg_surface.set_window_geometry of the + parent surface. + + When the xdg_positioner object is used to position a child surface, the + anchor rectangle may not extend outside the window geometry of the + positioned child's parent surface. + + If a negative size is set the invalid_input error is raised. + </description> + <arg name="x" type="int" summary="x position of anchor rectangle"/> + <arg name="y" type="int" summary="y position of anchor rectangle"/> + <arg name="width" type="int" summary="width of anchor rectangle"/> + <arg name="height" type="int" summary="height of anchor rectangle"/> + </request> + + <enum name="anchor"> + <entry name="none" value="0"/> + <entry name="top" value="1"/> + <entry name="bottom" value="2"/> + <entry name="left" value="3"/> + <entry name="right" value="4"/> + <entry name="top_left" value="5"/> + <entry name="bottom_left" value="6"/> + <entry name="top_right" value="7"/> + <entry name="bottom_right" value="8"/> + </enum> + + <request name="set_anchor"> + <description summary="set anchor rectangle anchor"> + Defines the anchor point for the anchor rectangle. The specified anchor + is used derive an anchor point that the child surface will be + positioned relative to. If a corner anchor is set (e.g. 'top_left' or + 'bottom_right'), the anchor point will be at the specified corner; + otherwise, the derived anchor point will be centered on the specified + edge, or in the center of the anchor rectangle if no edge is specified. + </description> + <arg name="anchor" type="uint" enum="anchor" + summary="anchor"/> + </request> + + <enum name="gravity"> + <entry name="none" value="0"/> + <entry name="top" value="1"/> + <entry name="bottom" value="2"/> + <entry name="left" value="3"/> + <entry name="right" value="4"/> + <entry name="top_left" value="5"/> + <entry name="bottom_left" value="6"/> + <entry name="top_right" value="7"/> + <entry name="bottom_right" value="8"/> + </enum> + + <request name="set_gravity"> + <description summary="set child surface gravity"> + Defines in what direction a surface should be positioned, relative to + the anchor point of the parent surface. If a corner gravity is + specified (e.g. 'bottom_right' or 'top_left'), then the child surface + will be placed towards the specified gravity; otherwise, the child + surface will be centered over the anchor point on any axis that had no + gravity specified. + </description> + <arg name="gravity" type="uint" enum="gravity" + summary="gravity direction"/> + </request> + + <enum name="constraint_adjustment" bitfield="true"> + <description summary="constraint adjustments"> + The constraint adjustment value define ways the compositor will adjust + the position of the surface, if the unadjusted position would result + in the surface being partly constrained. + + Whether a surface is considered 'constrained' is left to the compositor + to determine. For example, the surface may be partly outside the + compositor's defined 'work area', thus necessitating the child surface's + position be adjusted until it is entirely inside the work area. + + The adjustments can be combined, according to a defined precedence: 1) + Flip, 2) Slide, 3) Resize. + </description> + <entry name="none" value="0"> + <description summary="don't move the child surface when constrained"> + Don't alter the surface position even if it is constrained on some + axis, for example partially outside the edge of an output. + </description> + </entry> + <entry name="slide_x" value="1"> + <description summary="move along the x axis until unconstrained"> + Slide the surface along the x axis until it is no longer constrained. + + First try to slide towards the direction of the gravity on the x axis + until either the edge in the opposite direction of the gravity is + unconstrained or the edge in the direction of the gravity is + constrained. + + Then try to slide towards the opposite direction of the gravity on the + x axis until either the edge in the direction of the gravity is + unconstrained or the edge in the opposite direction of the gravity is + constrained. + </description> + </entry> + <entry name="slide_y" value="2"> + <description summary="move along the y axis until unconstrained"> + Slide the surface along the y axis until it is no longer constrained. + + First try to slide towards the direction of the gravity on the y axis + until either the edge in the opposite direction of the gravity is + unconstrained or the edge in the direction of the gravity is + constrained. + + Then try to slide towards the opposite direction of the gravity on the + y axis until either the edge in the direction of the gravity is + unconstrained or the edge in the opposite direction of the gravity is + constrained. + </description> + </entry> + <entry name="flip_x" value="4"> + <description summary="invert the anchor and gravity on the x axis"> + Invert the anchor and gravity on the x axis if the surface is + constrained on the x axis. For example, if the left edge of the + surface is constrained, the gravity is 'left' and the anchor is + 'left', change the gravity to 'right' and the anchor to 'right'. + + If the adjusted position also ends up being constrained, the resulting + position of the flip_x adjustment will be the one before the + adjustment. + </description> + </entry> + <entry name="flip_y" value="8"> + <description summary="invert the anchor and gravity on the y axis"> + Invert the anchor and gravity on the y axis if the surface is + constrained on the y axis. For example, if the bottom edge of the + surface is constrained, the gravity is 'bottom' and the anchor is + 'bottom', change the gravity to 'top' and the anchor to 'top'. + + The adjusted position is calculated given the original anchor + rectangle and offset, but with the new flipped anchor and gravity + values. + + If the adjusted position also ends up being constrained, the resulting + position of the flip_y adjustment will be the one before the + adjustment. + </description> + </entry> + <entry name="resize_x" value="16"> + <description summary="horizontally resize the surface"> + Resize the surface horizontally so that it is completely + unconstrained. + </description> + </entry> + <entry name="resize_y" value="32"> + <description summary="vertically resize the surface"> + Resize the surface vertically so that it is completely unconstrained. + </description> + </entry> + </enum> + + <request name="set_constraint_adjustment"> + <description summary="set the adjustment to be done when constrained"> + Specify how the window should be positioned if the originally intended + position caused the surface to be constrained, meaning at least + partially outside positioning boundaries set by the compositor. The + adjustment is set by constructing a bitmask describing the adjustment to + be made when the surface is constrained on that axis. + + If no bit for one axis is set, the compositor will assume that the child + surface should not change its position on that axis when constrained. + + If more than one bit for one axis is set, the order of how adjustments + are applied is specified in the corresponding adjustment descriptions. + + The default adjustment is none. + </description> + <arg name="constraint_adjustment" type="uint" + summary="bit mask of constraint adjustments"/> + </request> + + <request name="set_offset"> + <description summary="set surface position offset"> + Specify the surface position offset relative to the position of the + anchor on the anchor rectangle and the anchor on the surface. For + example if the anchor of the anchor rectangle is at (x, y), the surface + has the gravity bottom|right, and the offset is (ox, oy), the calculated + surface position will be (x + ox, y + oy). The offset position of the + surface is the one used for constraint testing. See + set_constraint_adjustment. + + An example use case is placing a popup menu on top of a user interface + element, while aligning the user interface element of the parent surface + with some user interface element placed somewhere in the popup surface. + </description> + <arg name="x" type="int" summary="surface position x offset"/> + <arg name="y" type="int" summary="surface position y offset"/> + </request> + + <!-- Version 3 additions --> + + <request name="set_reactive" since="3"> + <description summary="continuously reconstrain the surface"> + When set reactive, the surface is reconstrained if the conditions used + for constraining changed, e.g. the parent window moved. + + If the conditions changed and the popup was reconstrained, an + xdg_popup.configure event is sent with updated geometry, followed by an + xdg_surface.configure event. + </description> + </request> + + <request name="set_parent_size" since="3"> + <description summary=""> + Set the parent window geometry the compositor should use when + positioning the popup. The compositor may use this information to + determine the future state the popup should be constrained using. If + this doesn't match the dimension of the parent the popup is eventually + positioned against, the behavior is undefined. + + The arguments are given in the surface-local coordinate space. + </description> + <arg name="parent_width" type="int" + summary="future window geometry width of parent"/> + <arg name="parent_height" type="int" + summary="future window geometry height of parent"/> + </request> + + <request name="set_parent_configure" since="3"> + <description summary="set parent configure this is a response to"> + Set the serial of an xdg_surface.configure event this positioner will be + used in response to. The compositor may use this information together + with set_parent_size to determine what future state the popup should be + constrained using. + </description> + <arg name="serial" type="uint" + summary="serial of parent configure event"/> + </request> + </interface> + + <interface name="xdg_surface" version="3"> + <description summary="desktop user interface surface base interface"> + An interface that may be implemented by a wl_surface, for + implementations that provide a desktop-style user interface. + + It provides a base set of functionality required to construct user + interface elements requiring management by the compositor, such as + toplevel windows, menus, etc. The types of functionality are split into + xdg_surface roles. + + Creating an xdg_surface does not set the role for a wl_surface. In order + to map an xdg_surface, the client must create a role-specific object + using, e.g., get_toplevel, get_popup. The wl_surface for any given + xdg_surface can have at most one role, and may not be assigned any role + not based on xdg_surface. + + A role must be assigned before any other requests are made to the + xdg_surface object. + + The client must call wl_surface.commit on the corresponding wl_surface + for the xdg_surface state to take effect. + + Creating an xdg_surface from a wl_surface which has a buffer attached or + committed is a client error, and any attempts by a client to attach or + manipulate a buffer prior to the first xdg_surface.configure call must + also be treated as errors. + + After creating a role-specific object and setting it up, the client must + perform an initial commit without any buffer attached. The compositor + will reply with an xdg_surface.configure event. The client must + acknowledge it and is then allowed to attach a buffer to map the surface. + + Mapping an xdg_surface-based role surface is defined as making it + possible for the surface to be shown by the compositor. Note that + a mapped surface is not guaranteed to be visible once it is mapped. + + For an xdg_surface to be mapped by the compositor, the following + conditions must be met: + (1) the client has assigned an xdg_surface-based role to the surface + (2) the client has set and committed the xdg_surface state and the + role-dependent state to the surface + (3) the client has committed a buffer to the surface + + A newly-unmapped surface is considered to have met condition (1) out + of the 3 required conditions for mapping a surface if its role surface + has not been destroyed. + </description> + + <enum name="error"> + <entry name="not_constructed" value="1"/> + <entry name="already_constructed" value="2"/> + <entry name="unconfigured_buffer" value="3"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="destroy the xdg_surface"> + Destroy the xdg_surface object. An xdg_surface must only be destroyed + after its role object has been destroyed. + </description> + </request> + + <request name="get_toplevel"> + <description summary="assign the xdg_toplevel surface role"> + This creates an xdg_toplevel object for the given xdg_surface and gives + the associated wl_surface the xdg_toplevel role. + + See the documentation of xdg_toplevel for more details about what an + xdg_toplevel is and how it is used. + </description> + <arg name="id" type="new_id" interface="xdg_toplevel"/> + </request> + + <request name="get_popup"> + <description summary="assign the xdg_popup surface role"> + This creates an xdg_popup object for the given xdg_surface and gives + the associated wl_surface the xdg_popup role. + + If null is passed as a parent, a parent surface must be specified using + some other protocol, before committing the initial state. + + See the documentation of xdg_popup for more details about what an + xdg_popup is and how it is used. + </description> + <arg name="id" type="new_id" interface="xdg_popup"/> + <arg name="parent" type="object" interface="xdg_surface" allow-null="true"/> + <arg name="positioner" type="object" interface="xdg_positioner"/> + </request> + + <request name="set_window_geometry"> + <description summary="set the new window geometry"> + The window geometry of a surface is its "visible bounds" from the + user's perspective. Client-side decorations often have invisible + portions like drop-shadows which should be ignored for the + purposes of aligning, placing and constraining windows. + + The window geometry is double buffered, and will be applied at the + time wl_surface.commit of the corresponding wl_surface is called. + + When maintaining a position, the compositor should treat the (x, y) + coordinate of the window geometry as the top left corner of the window. + A client changing the (x, y) window geometry coordinate should in + general not alter the position of the window. + + Once the window geometry of the surface is set, it is not possible to + unset it, and it will remain the same until set_window_geometry is + called again, even if a new subsurface or buffer is attached. + + If never set, the value is the full bounds of the surface, + including any subsurfaces. This updates dynamically on every + commit. This unset is meant for extremely simple clients. + + The arguments are given in the surface-local coordinate space of + the wl_surface associated with this xdg_surface. + + The width and height must be greater than zero. Setting an invalid size + will raise an error. When applied, the effective window geometry will be + the set window geometry clamped to the bounding rectangle of the + combined geometry of the surface of the xdg_surface and the associated + subsurfaces. + </description> + <arg name="x" type="int"/> + <arg name="y" type="int"/> + <arg name="width" type="int"/> + <arg name="height" type="int"/> + </request> + + <request name="ack_configure"> + <description summary="ack a configure event"> + When a configure event is received, if a client commits the + surface in response to the configure event, then the client + must make an ack_configure request sometime before the commit + request, passing along the serial of the configure event. + + For instance, for toplevel surfaces the compositor might use this + information to move a surface to the top left only when the client has + drawn itself for the maximized or fullscreen state. + + If the client receives multiple configure events before it + can respond to one, it only has to ack the last configure event. + + A client is not required to commit immediately after sending + an ack_configure request - it may even ack_configure several times + before its next surface commit. + + A client may send multiple ack_configure requests before committing, but + only the last request sent before a commit indicates which configure + event the client really is responding to. + </description> + <arg name="serial" type="uint" summary="the serial from the configure event"/> + </request> + + <event name="configure"> + <description summary="suggest a surface change"> + The configure event marks the end of a configure sequence. A configure + sequence is a set of one or more events configuring the state of the + xdg_surface, including the final xdg_surface.configure event. + + Where applicable, xdg_surface surface roles will during a configure + sequence extend this event as a latched state sent as events before the + xdg_surface.configure event. Such events should be considered to make up + a set of atomically applied configuration states, where the + xdg_surface.configure commits the accumulated state. + + Clients should arrange their surface for the new states, and then send + an ack_configure request with the serial sent in this configure event at + some point before committing the new surface. + + If the client receives multiple configure events before it can respond + to one, it is free to discard all but the last event it received. + </description> + <arg name="serial" type="uint" summary="serial of the configure event"/> + </event> + + </interface> + + <interface name="xdg_toplevel" version="3"> + <description summary="toplevel surface"> + This interface defines an xdg_surface role which allows a surface to, + among other things, set window-like properties such as maximize, + fullscreen, and minimize, set application-specific metadata like title and + id, and well as trigger user interactive operations such as interactive + resize and move. + + Unmapping an xdg_toplevel means that the surface cannot be shown + by the compositor until it is explicitly mapped again. + All active operations (e.g., move, resize) are canceled and all + attributes (e.g. title, state, stacking, ...) are discarded for + an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to + the state it had right after xdg_surface.get_toplevel. The client + can re-map the toplevel by perfoming a commit without any buffer + attached, waiting for a configure event and handling it as usual (see + xdg_surface description). + + Attaching a null buffer to a toplevel unmaps the surface. + </description> + + <request name="destroy" type="destructor"> + <description summary="destroy the xdg_toplevel"> + This request destroys the role surface and unmaps the surface; + see "Unmapping" behavior in interface section for details. + </description> + </request> + + <request name="set_parent"> + <description summary="set the parent of this surface"> + Set the "parent" of this surface. This surface should be stacked + above the parent surface and all other ancestor surfaces. + + Parent windows should be set on dialogs, toolboxes, or other + "auxiliary" surfaces, so that the parent is raised when the dialog + is raised. + + Setting a null parent for a child window removes any parent-child + relationship for the child. Setting a null parent for a window which + currently has no parent is a no-op. + + If the parent is unmapped then its children are managed as + though the parent of the now-unmapped parent has become the + parent of this surface. If no parent exists for the now-unmapped + parent then the children are managed as though they have no + parent surface. + </description> + <arg name="parent" type="object" interface="xdg_toplevel" allow-null="true"/> + </request> + + <request name="set_title"> + <description summary="set surface title"> + Set a short title for the surface. + + This string may be used to identify the surface in a task bar, + window list, or other user interface elements provided by the + compositor. + + The string must be encoded in UTF-8. + </description> + <arg name="title" type="string"/> + </request> + + <request name="set_app_id"> + <description summary="set application ID"> + Set an application identifier for the surface. + + The app ID identifies the general class of applications to which + the surface belongs. The compositor can use this to group multiple + surfaces together, or to determine how to launch a new application. + + For D-Bus activatable applications, the app ID is used as the D-Bus + service name. + + The compositor shell will try to group application surfaces together + by their app ID. As a best practice, it is suggested to select app + ID's that match the basename of the application's .desktop file. + For example, "org.freedesktop.FooViewer" where the .desktop file is + "org.freedesktop.FooViewer.desktop". + + Like other properties, a set_app_id request can be sent after the + xdg_toplevel has been mapped to update the property. + + See the desktop-entry specification [0] for more details on + application identifiers and how they relate to well-known D-Bus + names and .desktop files. + + [0] http://standards.freedesktop.org/desktop-entry-spec/ + </description> + <arg name="app_id" type="string"/> + </request> + + <request name="show_window_menu"> + <description summary="show the window menu"> + Clients implementing client-side decorations might want to show + a context menu when right-clicking on the decorations, giving the + user a menu that they can use to maximize or minimize the window. + + This request asks the compositor to pop up such a window menu at + the given position, relative to the local surface coordinates of + the parent surface. There are no guarantees as to what menu items + the window menu contains. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. + </description> + <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/> + <arg name="serial" type="uint" summary="the serial of the user event"/> + <arg name="x" type="int" summary="the x position to pop up the window menu at"/> + <arg name="y" type="int" summary="the y position to pop up the window menu at"/> + </request> + + <request name="move"> + <description summary="start an interactive move"> + Start an interactive, user-driven move of the surface. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. The passed + serial is used to determine the type of interactive move (touch, + pointer, etc). + + The server may ignore move requests depending on the state of + the surface (e.g. fullscreen or maximized), or if the passed serial + is no longer valid. + + If triggered, the surface will lose the focus of the device + (wl_pointer, wl_touch, etc) used for the move. It is up to the + compositor to visually indicate that the move is taking place, such as + updating a pointer cursor, during the move. There is no guarantee + that the device focus will return when the move is completed. + </description> + <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/> + <arg name="serial" type="uint" summary="the serial of the user event"/> + </request> + + <enum name="resize_edge"> + <description summary="edge values for resizing"> + These values are used to indicate which edge of a surface + is being dragged in a resize operation. + </description> + <entry name="none" value="0"/> + <entry name="top" value="1"/> + <entry name="bottom" value="2"/> + <entry name="left" value="4"/> + <entry name="top_left" value="5"/> + <entry name="bottom_left" value="6"/> + <entry name="right" value="8"/> + <entry name="top_right" value="9"/> + <entry name="bottom_right" value="10"/> + </enum> + + <request name="resize"> + <description summary="start an interactive resize"> + Start a user-driven, interactive resize of the surface. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. The passed + serial is used to determine the type of interactive resize (touch, + pointer, etc). + + The server may ignore resize requests depending on the state of + the surface (e.g. fullscreen or maximized). + + If triggered, the client will receive configure events with the + "resize" state enum value and the expected sizes. See the "resize" + enum value for more details about what is required. The client + must also acknowledge configure events using "ack_configure". After + the resize is completed, the client will receive another "configure" + event without the resize state. + + If triggered, the surface also will lose the focus of the device + (wl_pointer, wl_touch, etc) used for the resize. It is up to the + compositor to visually indicate that the resize is taking place, + such as updating a pointer cursor, during the resize. There is no + guarantee that the device focus will return when the resize is + completed. + + The edges parameter specifies how the surface should be resized, + and is one of the values of the resize_edge enum. The compositor + may use this information to update the surface position for + example when dragging the top left corner. The compositor may also + use this information to adapt its behavior, e.g. choose an + appropriate cursor image. + </description> + <arg name="seat" type="object" interface="wl_seat" summary="the wl_seat of the user event"/> + <arg name="serial" type="uint" summary="the serial of the user event"/> + <arg name="edges" type="uint" enum="resize_edge" summary="which edge or corner is being dragged"/> + </request> + + <enum name="state"> + <description summary="types of state on the surface"> + The different state values used on the surface. This is designed for + state values like maximized, fullscreen. It is paired with the + configure event to ensure that both the client and the compositor + setting the state can be synchronized. + + States set in this way are double-buffered. They will get applied on + the next commit. + </description> + <entry name="maximized" value="1" summary="the surface is maximized"> + <description summary="the surface is maximized"> + The surface is maximized. The window geometry specified in the configure + event must be obeyed by the client. + + The client should draw without shadow or other + decoration outside of the window geometry. + </description> + </entry> + <entry name="fullscreen" value="2" summary="the surface is fullscreen"> + <description summary="the surface is fullscreen"> + The surface is fullscreen. The window geometry specified in the + configure event is a maximum; the client cannot resize beyond it. For + a surface to cover the whole fullscreened area, the geometry + dimensions must be obeyed by the client. For more details, see + xdg_toplevel.set_fullscreen. + </description> + </entry> + <entry name="resizing" value="3" summary="the surface is being resized"> + <description summary="the surface is being resized"> + The surface is being resized. The window geometry specified in the + configure event is a maximum; the client cannot resize beyond it. + Clients that have aspect ratio or cell sizing configuration can use + a smaller size, however. + </description> + </entry> + <entry name="activated" value="4" summary="the surface is now activated"> + <description summary="the surface is now activated"> + Client window decorations should be painted as if the window is + active. Do not assume this means that the window actually has + keyboard or pointer focus. + </description> + </entry> + <entry name="tiled_left" value="5" since="2"> + <description summary="the surface is tiled"> + The window is currently in a tiled layout and the left edge is + considered to be adjacent to another part of the tiling grid. + </description> + </entry> + <entry name="tiled_right" value="6" since="2"> + <description summary="the surface is tiled"> + The window is currently in a tiled layout and the right edge is + considered to be adjacent to another part of the tiling grid. + </description> + </entry> + <entry name="tiled_top" value="7" since="2"> + <description summary="the surface is tiled"> + The window is currently in a tiled layout and the top edge is + considered to be adjacent to another part of the tiling grid. + </description> + </entry> + <entry name="tiled_bottom" value="8" since="2"> + <description summary="the surface is tiled"> + The window is currently in a tiled layout and the bottom edge is + considered to be adjacent to another part of the tiling grid. + </description> + </entry> + </enum> + + <request name="set_max_size"> + <description summary="set the maximum size"> + Set a maximum size for the window. + + The client can specify a maximum size so that the compositor does + not try to configure the window beyond this size. + + The width and height arguments are in window geometry coordinates. + See xdg_surface.set_window_geometry. + + Values set in this way are double-buffered. They will get applied + on the next commit. + + The compositor can use this information to allow or disallow + different states like maximize or fullscreen and draw accurate + animations. + + Similarly, a tiling window manager may use this information to + place and resize client windows in a more effective way. + + The client should not rely on the compositor to obey the maximum + size. The compositor may decide to ignore the values set by the + client and request a larger size. + + If never set, or a value of zero in the request, means that the + client has no expected maximum size in the given dimension. + As a result, a client wishing to reset the maximum size + to an unspecified state can use zero for width and height in the + request. + + Requesting a maximum size to be smaller than the minimum size of + a surface is illegal and will result in a protocol error. + + The width and height must be greater than or equal to zero. Using + strictly negative values for width and height will result in a + protocol error. + </description> + <arg name="width" type="int"/> + <arg name="height" type="int"/> + </request> + + <request name="set_min_size"> + <description summary="set the minimum size"> + Set a minimum size for the window. + + The client can specify a minimum size so that the compositor does + not try to configure the window below this size. + + The width and height arguments are in window geometry coordinates. + See xdg_surface.set_window_geometry. + + Values set in this way are double-buffered. They will get applied + on the next commit. + + The compositor can use this information to allow or disallow + different states like maximize or fullscreen and draw accurate + animations. + + Similarly, a tiling window manager may use this information to + place and resize client windows in a more effective way. + + The client should not rely on the compositor to obey the minimum + size. The compositor may decide to ignore the values set by the + client and request a smaller size. + + If never set, or a value of zero in the request, means that the + client has no expected minimum size in the given dimension. + As a result, a client wishing to reset the minimum size + to an unspecified state can use zero for width and height in the + request. + + Requesting a minimum size to be larger than the maximum size of + a surface is illegal and will result in a protocol error. + + The width and height must be greater than or equal to zero. Using + strictly negative values for width and height will result in a + protocol error. + </description> + <arg name="width" type="int"/> + <arg name="height" type="int"/> + </request> + + <request name="set_maximized"> + <description summary="maximize the window"> + Maximize the surface. + + After requesting that the surface should be maximized, the compositor + will respond by emitting a configure event. Whether this configure + actually sets the window maximized is subject to compositor policies. + The client must then update its content, drawing in the configured + state. The client must also acknowledge the configure when committing + the new content (see ack_configure). + + It is up to the compositor to decide how and where to maximize the + surface, for example which output and what region of the screen should + be used. + + If the surface was already maximized, the compositor will still emit + a configure event with the "maximized" state. + + If the surface is in a fullscreen state, this request has no direct + effect. It may alter the state the surface is returned to when + unmaximized unless overridden by the compositor. + </description> + </request> + + <request name="unset_maximized"> + <description summary="unmaximize the window"> + Unmaximize the surface. + + After requesting that the surface should be unmaximized, the compositor + will respond by emitting a configure event. Whether this actually + un-maximizes the window is subject to compositor policies. + If available and applicable, the compositor will include the window + geometry dimensions the window had prior to being maximized in the + configure event. The client must then update its content, drawing it in + the configured state. The client must also acknowledge the configure + when committing the new content (see ack_configure). + + It is up to the compositor to position the surface after it was + unmaximized; usually the position the surface had before maximizing, if + applicable. + + If the surface was already not maximized, the compositor will still + emit a configure event without the "maximized" state. + + If the surface is in a fullscreen state, this request has no direct + effect. It may alter the state the surface is returned to when + unmaximized unless overridden by the compositor. + </description> + </request> + + <request name="set_fullscreen"> + <description summary="set the window as fullscreen on an output"> + Make the surface fullscreen. + + After requesting that the surface should be fullscreened, the + compositor will respond by emitting a configure event. Whether the + client is actually put into a fullscreen state is subject to compositor + policies. The client must also acknowledge the configure when + committing the new content (see ack_configure). + + The output passed by the request indicates the client's preference as + to which display it should be set fullscreen on. If this value is NULL, + it's up to the compositor to choose which display will be used to map + this surface. + + If the surface doesn't cover the whole output, the compositor will + position the surface in the center of the output and compensate with + with border fill covering the rest of the output. The content of the + border fill is undefined, but should be assumed to be in some way that + attempts to blend into the surrounding area (e.g. solid black). + + If the fullscreened surface is not opaque, the compositor must make + sure that other screen content not part of the same surface tree (made + up of subsurfaces, popups or similarly coupled surfaces) are not + visible below the fullscreened surface. + </description> + <arg name="output" type="object" interface="wl_output" allow-null="true"/> + </request> + + <request name="unset_fullscreen"> + <description summary="unset the window as fullscreen"> + Make the surface no longer fullscreen. + + After requesting that the surface should be unfullscreened, the + compositor will respond by emitting a configure event. + Whether this actually removes the fullscreen state of the client is + subject to compositor policies. + + Making a surface unfullscreen sets states for the surface based on the following: + * the state(s) it may have had before becoming fullscreen + * any state(s) decided by the compositor + * any state(s) requested by the client while the surface was fullscreen + + The compositor may include the previous window geometry dimensions in + the configure event, if applicable. + + The client must also acknowledge the configure when committing the new + content (see ack_configure). + </description> + </request> + + <request name="set_minimized"> + <description summary="set the window as minimized"> + Request that the compositor minimize your surface. There is no + way to know if the surface is currently minimized, nor is there + any way to unset minimization on this surface. + + If you are looking to throttle redrawing when minimized, please + instead use the wl_surface.frame event for this, as this will + also work with live previews on windows in Alt-Tab, Expose or + similar compositor features. + </description> + </request> + + <event name="configure"> + <description summary="suggest a surface change"> + This configure event asks the client to resize its toplevel surface or + to change its state. The configured state should not be applied + immediately. See xdg_surface.configure for details. + + The width and height arguments specify a hint to the window + about how its surface should be resized in window geometry + coordinates. See set_window_geometry. + + If the width or height arguments are zero, it means the client + should decide its own window dimension. This may happen when the + compositor needs to configure the state of the surface but doesn't + have any information about any previous or expected dimension. + + The states listed in the event specify how the width/height + arguments should be interpreted, and possibly how it should be + drawn. + + Clients must send an ack_configure in response to this event. See + xdg_surface.configure and xdg_surface.ack_configure for details. + </description> + <arg name="width" type="int"/> + <arg name="height" type="int"/> + <arg name="states" type="array"/> + </event> + + <event name="close"> + <description summary="surface wants to be closed"> + The close event is sent by the compositor when the user + wants the surface to be closed. This should be equivalent to + the user clicking the close button in client-side decorations, + if your application has any. + + This is only a request that the user intends to close the + window. The client may choose to ignore this request, or show + a dialog to ask the user to save their data, etc. + </description> + </event> + </interface> + + <interface name="xdg_popup" version="3"> + <description summary="short-lived, popup surfaces for menus"> + A popup surface is a short-lived, temporary surface. It can be used to + implement for example menus, popovers, tooltips and other similar user + interface concepts. + + A popup can be made to take an explicit grab. See xdg_popup.grab for + details. + + When the popup is dismissed, a popup_done event will be sent out, and at + the same time the surface will be unmapped. See the xdg_popup.popup_done + event for details. + + Explicitly destroying the xdg_popup object will also dismiss the popup and + unmap the surface. Clients that want to dismiss the popup when another + surface of their own is clicked should dismiss the popup using the destroy + request. + + A newly created xdg_popup will be stacked on top of all previously created + xdg_popup surfaces associated with the same xdg_toplevel. + + The parent of an xdg_popup must be mapped (see the xdg_surface + description) before the xdg_popup itself. + + The client must call wl_surface.commit on the corresponding wl_surface + for the xdg_popup state to take effect. + </description> + + <enum name="error"> + <entry name="invalid_grab" value="0" + summary="tried to grab after being mapped"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="remove xdg_popup interface"> + This destroys the popup. Explicitly destroying the xdg_popup + object will also dismiss the popup, and unmap the surface. + + If this xdg_popup is not the "topmost" popup, a protocol error + will be sent. + </description> + </request> + + <request name="grab"> + <description summary="make the popup take an explicit grab"> + This request makes the created popup take an explicit grab. An explicit + grab will be dismissed when the user dismisses the popup, or when the + client destroys the xdg_popup. This can be done by the user clicking + outside the surface, using the keyboard, or even locking the screen + through closing the lid or a timeout. + + If the compositor denies the grab, the popup will be immediately + dismissed. + + This request must be used in response to some sort of user action like a + button press, key press, or touch down event. The serial number of the + event should be passed as 'serial'. + + The parent of a grabbing popup must either be an xdg_toplevel surface or + another xdg_popup with an explicit grab. If the parent is another + xdg_popup it means that the popups are nested, with this popup now being + the topmost popup. + + Nested popups must be destroyed in the reverse order they were created + in, e.g. the only popup you are allowed to destroy at all times is the + topmost one. + + When compositors choose to dismiss a popup, they may dismiss every + nested grabbing popup as well. When a compositor dismisses popups, it + will follow the same dismissing order as required from the client. + + The parent of a grabbing popup must either be another xdg_popup with an + active explicit grab, or an xdg_popup or xdg_toplevel, if there are no + explicit grabs already taken. + + If the topmost grabbing popup is destroyed, the grab will be returned to + the parent of the popup, if that parent previously had an explicit grab. + + If the parent is a grabbing popup which has already been dismissed, this + popup will be immediately dismissed. If the parent is a popup that did + not take an explicit grab, an error will be raised. + + During a popup grab, the client owning the grab will receive pointer + and touch events for all their surfaces as normal (similar to an + "owner-events" grab in X11 parlance), while the top most grabbing popup + will always have keyboard focus. + </description> + <arg name="seat" type="object" interface="wl_seat" + summary="the wl_seat of the user event"/> + <arg name="serial" type="uint" summary="the serial of the user event"/> + </request> + + <event name="configure"> + <description summary="configure the popup surface"> + This event asks the popup surface to configure itself given the + configuration. The configured state should not be applied immediately. + See xdg_surface.configure for details. + + The x and y arguments represent the position the popup was placed at + given the xdg_positioner rule, relative to the upper left corner of the + window geometry of the parent surface. + + For version 2 or older, the configure event for an xdg_popup is only + ever sent once for the initial configuration. Starting with version 3, + it may be sent again if the popup is setup with an xdg_positioner with + set_reactive requested, or in response to xdg_popup.reposition requests. + </description> + <arg name="x" type="int" + summary="x position relative to parent surface window geometry"/> + <arg name="y" type="int" + summary="y position relative to parent surface window geometry"/> + <arg name="width" type="int" summary="window geometry width"/> + <arg name="height" type="int" summary="window geometry height"/> + </event> + + <event name="popup_done"> + <description summary="popup interaction is done"> + The popup_done event is sent out when a popup is dismissed by the + compositor. The client should destroy the xdg_popup object at this + point. + </description> + </event> + + <!-- Version 3 additions --> + + <request name="reposition" since="3"> + <description summary="recalculate the popup's location"> + Reposition an already-mapped popup. The popup will be placed given the + details in the passed xdg_positioner object, and a + xdg_popup.repositioned followed by xdg_popup.configure and + xdg_surface.configure will be emitted in response. Any parameters set + by the previous positioner will be discarded. + + The passed token will be sent in the corresponding + xdg_popup.repositioned event. The new popup position will not take + effect until the corresponding configure event is acknowledged by the + client. See xdg_popup.repositioned for details. The token itself is + opaque, and has no other special meaning. + + If multiple reposition requests are sent, the compositor may skip all + but the last one. + + If the popup is repositioned in response to a configure event for its + parent, the client should send an xdg_positioner.set_parent_configure + and possibly an xdg_positioner.set_parent_size request to allow the + compositor to properly constrain the popup. + + If the popup is repositioned together with a parent that is being + resized, but not in response to a configure event, the client should + send an xdg_positioner.set_parent_size request. + </description> + <arg name="positioner" type="object" interface="xdg_positioner"/> + <arg name="token" type="uint" summary="reposition request token"/> + </request> + + <event name="repositioned" since="3"> + <description summary="signal the completion of a repositioned request"> + The repositioned event is sent as part of a popup configuration + sequence, together with xdg_popup.configure and lastly + xdg_surface.configure to notify the completion of a reposition request. + + The repositioned event is to notify about the completion of a + xdg_popup.reposition request. The token argument is the token passed + in the xdg_popup.reposition request. + + Immediately after this event is emitted, xdg_popup.configure and + xdg_surface.configure will be sent with the updated size and position, + as well as a new configure serial. + + The client should optionally update the content of the popup, but must + acknowledge the new popup configuration for the new position to take + effect. See xdg_surface.ack_configure for details. + </description> + <arg name="token" type="uint" summary="reposition request token"/> + </event> + + </interface> +</protocol> diff --git a/Sources/Seat/OwlKeyboard.h b/Sources/Seat/OwlKeyboard.h new file mode 100644 index 0000000..ab89317 --- /dev/null +++ b/Sources/Seat/OwlKeyboard.h @@ -0,0 +1,39 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@class OwlSurface; + +@interface OwlKeyboard : NSObject { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +- (struct wl_resource *) resource; + ++ (OwlKeyboard *) keyboardForClient: (struct wl_client *) client; + +- (void) sendEnterSurface: (OwlSurface *) surface; +- (void) sendLeaveSurface: (OwlSurface *) surface; +- (void) sendKey: (unsigned short) keyCode isPressed: (BOOL) isPressed; +- (void) sendModifiers: (uint32_t) modifiers; + +@end diff --git a/Sources/Seat/OwlKeyboard.m b/Sources/Seat/OwlKeyboard.m new file mode 100644 index 0000000..399be1b --- /dev/null +++ b/Sources/Seat/OwlKeyboard.m @@ -0,0 +1,264 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlKeyboard.h" +#import <xkbcommon/xkbcommon.h> +#import <fcntl.h> +#import <unistd.h> +#import "OwlServer.h" +#import "OwlSurface.h" +#import "OwlFeatures.h" + +#ifdef OWL_PLATFORM_APPLE + #import <Carbon/Carbon.h> +#endif + + +@implementation OwlKeyboard + +static NSMutableArray *keyboards; + ++ (void) initialize { + if (keyboards == nil) { + keyboards = [[NSMutableArray alloc] initWithCapacity: 1]; + } +} + ++ (OwlKeyboard *) keyboardForClient: (struct wl_client *) client { + for (OwlKeyboard *keyboard in keyboards) { + struct wl_resource *resource = keyboard->_resource; + if (client == wl_resource_get_client(resource)) { + return keyboard; + } + } + return nil; +} + +static void keyboard_destroy(struct wl_resource *resource) { + OwlKeyboard *self = wl_resource_get_user_data(resource); + [keyboards removeObjectIdenticalTo: self]; + [self release]; +} + +static void keyboard_release_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static const struct wl_keyboard_interface keyboard_impl = { + .release = keyboard_release_handler +}; + +- (void) sendKeymap { + NSString *path = [[NSBundle mainBundle] pathForResource: @"keymap" + ofType: @"xkb"]; + int fd = open([path fileSystemRepresentation], O_RDONLY); + uint32_t len = lseek(fd, 0, SEEK_END); + lseek(fd, 0, SEEK_SET); + wl_keyboard_send_keymap( + _resource, + WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1, + fd, + len + ); + close(fd); +} + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + [keyboards addObject: self]; + + wl_resource_set_implementation( + resource, + &keyboard_impl, + [self retain], + keyboard_destroy + ); + + [self sendKeymap]; + + return self; +} + +- (struct wl_resource *) resource { + return _resource; +} + +#ifdef OWL_PLATFORM_APPLE +static const struct { + unsigned short cocoaKeyCode; + uint32_t xkbKeyCode; +} keymap[] = { + {kVK_Escape, 1}, + + {kVK_ANSI_1, 2}, + {kVK_ANSI_2, 3}, + {kVK_ANSI_3, 4}, + {kVK_ANSI_4, 5}, + {kVK_ANSI_5, 6}, + {kVK_ANSI_6, 7}, + {kVK_ANSI_7, 8}, + {kVK_ANSI_8, 9}, + {kVK_ANSI_9, 10}, + {kVK_ANSI_0, 11}, + + {kVK_ANSI_Minus, 12}, + {kVK_ANSI_Equal, 13}, + {kVK_Delete, 14}, // backspace + {kVK_Tab, 15}, + + {kVK_ANSI_Q, 16}, + {kVK_ANSI_W, 17}, + {kVK_ANSI_E, 18}, + {kVK_ANSI_R, 19}, + {kVK_ANSI_T, 20}, + {kVK_ANSI_Y, 21}, + {kVK_ANSI_U, 22}, + {kVK_ANSI_I, 23}, + {kVK_ANSI_O, 24}, + {kVK_ANSI_P, 25}, + + {kVK_ANSI_LeftBracket, 26}, + {kVK_ANSI_RightBracket, 27}, + {kVK_Return, 28}, // enter + + {kVK_ANSI_A, 30}, + {kVK_ANSI_S, 31}, + {kVK_ANSI_D, 32}, + {kVK_ANSI_F, 33}, + {kVK_ANSI_G, 34}, + {kVK_ANSI_H, 35}, + {kVK_ANSI_J, 36}, + {kVK_ANSI_K, 37}, + {kVK_ANSI_L, 38}, + + {kVK_ANSI_Semicolon, 39}, + {kVK_ANSI_Quote, 40}, + {kVK_ANSI_Grave, 41}, + {kVK_ANSI_Backslash, 43}, + + {kVK_ANSI_Z, 44}, + {kVK_ANSI_X, 45}, + {kVK_ANSI_C, 46}, + {kVK_ANSI_V, 47}, + {kVK_ANSI_B, 48}, + {kVK_ANSI_N, 49}, + {kVK_ANSI_M, 50}, + + {kVK_ANSI_Comma, 51}, + {kVK_ANSI_Period, 52}, + {kVK_ANSI_Slash, 53}, + {kVK_Space, 57}, + + {kVK_F1, 59}, + {kVK_F2, 60}, + {kVK_F3, 61}, + {kVK_F4, 62}, + {kVK_F5, 63}, + {kVK_F6, 64}, + {kVK_F7, 65}, + {kVK_F8, 66}, + {kVK_F9, 67}, + {kVK_F10, 68}, + + {kVK_F11, 87}, + {kVK_F12, 88}, + + {kVK_Home, 102}, + {kVK_UpArrow, 103}, + {kVK_PageUp, 104}, + {kVK_LeftArrow, 105}, + {kVK_RightArrow, 106}, + {kVK_End, 107}, + {kVK_DownArrow, 108}, + {kVK_PageDown, 109}, + {kVK_ForwardDelete, 111} +}; + +- (uint32_t) xkbKeyCodeForCocoaKeyCode: (unsigned short) cocoaKeyCode { + size_t keymap_size = sizeof(keymap) / sizeof(*keymap); + for (size_t i = 0; i < keymap_size; i++) { + if (keymap[i].cocoaKeyCode == cocoaKeyCode) { + return keymap[i].xkbKeyCode; + } + } + return 0; +} + +#else /* OWL_PLATFORM_APPLE */ + +- (uint32_t) xkbKeyCodeForCocoaKeyCode: (unsigned short) keyCode { + static const struct { + unsigned short from, to; + uint32_t base; + } translations[] = { + {10, 22, 2}, + {24, 35, 16}, + {38, 48, 30}, + {52, 61, 44}, + {65, 65, 57}, + {36, 36, 28} + }; + size_t translations_size = sizeof(translations) / sizeof(translations[0]); + + for (size_t i = 0; i < translations_size; i++) { + if (keyCode >= translations[i].from && keyCode <= translations[i].to) { + return keyCode - translations[i].from + translations[i].base; + } + } + return keyCode; +} + + +#endif /* OWL_PLATFORM_APPLE */ + +- (void) sendKey: (unsigned short) keyCode isPressed: (BOOL) isPressed { + enum wl_keyboard_key_state state = isPressed + ? WL_KEYBOARD_KEY_STATE_PRESSED + : WL_KEYBOARD_KEY_STATE_RELEASED; + + wl_keyboard_send_key( + _resource, + [[OwlServer sharedServer] nextSerial], + [OwlServer timestamp], + [self xkbKeyCodeForCocoaKeyCode: keyCode], + state + ); +} + +- (void) sendModifiers: (uint32_t) modifiers { + uint32_t serial = [[OwlServer sharedServer] nextSerial]; + wl_keyboard_send_modifiers(_resource, serial, modifiers, 0, 0, 0); +} + +- (void) sendEnterSurface: (OwlSurface *) surface { + uint32_t serial = [[OwlServer sharedServer] nextSerial]; + struct wl_array keys; + wl_array_init(&keys); + wl_keyboard_send_enter(_resource, serial, [surface resource], &keys); + wl_array_release(&keys); +} + +- (void) sendLeaveSurface: (OwlSurface *) surface { + uint32_t serial = [[OwlServer sharedServer] nextSerial]; + wl_keyboard_send_leave(_resource, serial, [surface resource]); +} + +@end diff --git a/Sources/Seat/OwlPointer.h b/Sources/Seat/OwlPointer.h new file mode 100644 index 0000000..f69a105 --- /dev/null +++ b/Sources/Seat/OwlPointer.h @@ -0,0 +1,45 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@class OwlSurface; + +// These come from linux/event.h + +#define BTN_LEFT 0x100 +#define BTN_RIGHT 0x111 +#define BTN_MIDDLE 0x112 + + +@interface OwlPointer : NSObject { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; + ++ (OwlPointer *) pointerForClient: (struct wl_client *) client; + +- (void) sendEnterSurface: (OwlSurface *) surface atPoint: (NSPoint) point; +- (void) sendMotionAtPoint: (NSPoint) point; +- (void) sendLeaveSurface: (OwlSurface *) surface; +- (void) sendScrollByX: (CGFloat) deltaX byY: (CGFloat) deltaY; +- (void) sendButton: (uint32_t) button isPressed: (BOOL) isPressed; + +@end diff --git a/Sources/Seat/OwlPointer.m b/Sources/Seat/OwlPointer.m new file mode 100644 index 0000000..d754754 --- /dev/null +++ b/Sources/Seat/OwlPointer.m @@ -0,0 +1,145 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlPointer.h" +#import <wayland-server.h> +#import "OwlServer.h" +#import "OwlSurface.h" + + +@implementation OwlPointer + +static NSMutableArray *pointers; + ++ (void) initialize { + if (pointers == nil) { + pointers = [[NSMutableArray alloc] initWithCapacity: 1]; + } +} + ++ (OwlPointer *) pointerForClient: (struct wl_client *) client { + for (OwlPointer *pointer in pointers) { + struct wl_resource *resource = pointer->_resource; + if (client == wl_resource_get_client(resource)) { + return pointer; + } + } + return nil; +} + +static void pointer_set_cursor( + struct wl_client *client, + struct wl_resource *resource, + uint32_t serial, + struct wl_resource *surface_resource, + int32_t hotspot_x, + int32_t hotspot_y +) { + // TODO +} + +static const struct wl_pointer_interface pointer_impl = { + .set_cursor = pointer_set_cursor +}; + +static void pointer_destroy(struct wl_resource *resource) { + OwlPointer *self = wl_resource_get_user_data(resource); + [pointers removeObjectIdenticalTo: self]; + [self release]; +} + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + [pointers addObject: self]; + wl_resource_set_implementation( + resource, + &pointer_impl, + [self retain], + pointer_destroy + ); + return self; +} + +- (struct wl_resource *) resource { + return _resource; +} + +- (void) sendEnterSurface: (OwlSurface *) surface atPoint: (NSPoint) point { + wl_pointer_send_enter( + _resource, + [[OwlServer sharedServer] nextSerial], + [surface resource], + wl_fixed_from_double(point.x), + wl_fixed_from_double(point.y) + ); +} + +- (void) sendMotionAtPoint: (NSPoint) point { + wl_pointer_send_motion( + _resource, + [OwlServer timestamp], + wl_fixed_from_double(point.x), + wl_fixed_from_double(point.y) + ); +} + +- (void) sendLeaveSurface: (OwlSurface *) surface { + wl_pointer_send_leave( + _resource, + [[OwlServer sharedServer] nextSerial], + [surface resource] + ); +} + +- (void) sendScrollByX: (CGFloat) deltaX byY: (CGFloat) deltaY { + uint32_t timestamp = [OwlServer timestamp]; + + if (deltaX != 0.0) { + wl_pointer_send_axis( + _resource, + timestamp, + WL_POINTER_AXIS_HORIZONTAL_SCROLL, + wl_fixed_from_double(deltaX) + ); + } + + if (deltaY != 0.0) { + wl_pointer_send_axis( + _resource, + timestamp, + WL_POINTER_AXIS_VERTICAL_SCROLL, + wl_fixed_from_double(-deltaY) + ); + } +} + +- (void) sendButton: (uint32_t) button isPressed: (BOOL) isPressed { + enum wl_pointer_button_state state = isPressed + ? WL_POINTER_BUTTON_STATE_PRESSED + : WL_POINTER_BUTTON_STATE_RELEASED; + + wl_pointer_send_button( + _resource, + [[OwlServer sharedServer] nextSerial], + [OwlServer timestamp], + button, + state + ); +} + +@end diff --git a/Sources/Seat/OwlSeat.h b/Sources/Seat/OwlSeat.h new file mode 100644 index 0000000..46d9324 --- /dev/null +++ b/Sources/Seat/OwlSeat.h @@ -0,0 +1,30 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlSeat : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +@end diff --git a/Sources/Seat/OwlSeat.m b/Sources/Seat/OwlSeat.m new file mode 100644 index 0000000..1fa87bc --- /dev/null +++ b/Sources/Seat/OwlSeat.m @@ -0,0 +1,104 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSeat.h" +#import "OwlPointer.h" +#import "OwlKeyboard.h" +#import <wayland-server.h> + +@implementation OwlSeat + +static void seat_get_pointer( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + uint32_t version = wl_resource_get_version(resource); + struct wl_resource *pointer_resource = wl_resource_create( + client, + &wl_pointer_interface, + version, + id + ); + [[[OwlPointer alloc] initWithResource: pointer_resource] release]; +} + +static void seat_get_keyboard( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + uint32_t version = wl_resource_get_version(resource); + struct wl_resource *keyboard_resource = wl_resource_create( + client, + &wl_keyboard_interface, + version, + id + ); + [[[OwlKeyboard alloc] initWithResource: keyboard_resource] release]; +} + +static const struct wl_seat_interface seat_impl = { + .get_pointer = seat_get_pointer, + .get_keyboard = seat_get_keyboard +}; + +static void seat_destroy(struct wl_resource *resource) { + OwlSeat *self = wl_resource_get_user_data(resource); + [self release]; +} + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + + wl_resource_set_implementation( + resource, + &seat_impl, + [self retain], + seat_destroy + ); + + wl_seat_send_capabilities( + resource, + WL_SEAT_CAPABILITY_POINTER | WL_SEAT_CAPABILITY_KEYBOARD + ); + wl_seat_send_name(resource, "seat0"); + + return self; +} + +static void seat_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &wl_seat_interface, + version, + id + ); + [[[OwlSeat alloc] initWithResource: resource] release]; +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create(display, &wl_seat_interface, 2, NULL, seat_bind); +} + +@end diff --git a/Sources/Server/OwlCallback.h b/Sources/Server/OwlCallback.h new file mode 100644 index 0000000..7d4e40c --- /dev/null +++ b/Sources/Server/OwlCallback.h @@ -0,0 +1,30 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@interface OwlCallback : NSObject { + struct wl_resource *_resource; +} + +- (id) initWithResource: (struct wl_resource *) resource; + +- (void) sendDoneWithData: (uint32_t) data; + +@end diff --git a/Sources/Server/OwlCallback.m b/Sources/Server/OwlCallback.m new file mode 100644 index 0000000..c5e1dae --- /dev/null +++ b/Sources/Server/OwlCallback.m @@ -0,0 +1,46 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlCallback.h" +#import <wayland-server.h> + +@implementation OwlCallback + +static void callback_destroy(struct wl_resource *resource) { + OwlCallback *self = wl_resource_get_user_data(resource); + [self release]; +} + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + NULL, + [self retain], + callback_destroy + ); + return self; +} + +- (void) sendDoneWithData: (uint32_t) data { + wl_callback_send_done(_resource, data); + // Sending a callback also implicitly destroys it. + wl_resource_destroy(_resource); +} + +@end diff --git a/Sources/Server/OwlGlobal.h b/Sources/Server/OwlGlobal.h new file mode 100644 index 0000000..2c784a9 --- /dev/null +++ b/Sources/Server/OwlGlobal.h @@ -0,0 +1,26 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <wayland-server.h> + + +@protocol OwlGlobal + ++ (void) addGlobalToDisplay: (struct wl_display *) display; + +@end diff --git a/Sources/Server/OwlRunLoopSource.h b/Sources/Server/OwlRunLoopSource.h new file mode 100644 index 0000000..4951cc9 --- /dev/null +++ b/Sources/Server/OwlRunLoopSource.h @@ -0,0 +1,43 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> +#import "OwlFeatures.h" + +#ifdef OWL_PLATFORM_GNUSTEP +@interface OwlRunLoopSource : NSObject<RunLoopEvents> { +#else +@interface OwlRunLoopSource : NSObject { +#endif + + struct wl_event_loop *_event_loop; + +#ifndef OWL_PLATFORM_GNUSTEP + CFSocketRef _socket; + CFRunLoopSourceRef _source; +#endif +} + +- (id) initWithEventLoop: (struct wl_event_loop *) event_loop; + +- (void) addToRunLoop; +- (void) removeFromRunLoop; + +@end + diff --git a/Sources/Server/OwlRunLoopSource.m b/Sources/Server/OwlRunLoopSource.m new file mode 100644 index 0000000..2205021 --- /dev/null +++ b/Sources/Server/OwlRunLoopSource.m @@ -0,0 +1,113 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlRunLoopSource.h" +#import "OwlServer.h" +#import "OwlFeatures.h" +#import <Cocoa/Cocoa.h> + +@implementation OwlRunLoopSource + +#ifndef OWL_PLATFORM_GNUSTEP +static void socketCallback( + CFSocketRef socket, + CFSocketCallBackType type, + CFDataRef address, + const void *data, + void *info +) { + OwlRunLoopSource *self = info; +#else +- (void) receivedEvent: (void *) data + type: (RunLoopEventType) type + extra: (void *) extra + forMode: (NSString *) mode +{ +#endif + + @try { + wl_event_loop_dispatch(self->_event_loop, 0); + } @catch (NSException *ex) { + NSLog(@"Internal error during wl_event_loop_dispatch(): %@", ex); + } + + [[OwlServer sharedServer] flushClients]; +} + +- (id) initWithEventLoop: (struct wl_event_loop *) event_loop { + _event_loop = event_loop; + +#ifndef OWL_PLATFORM_GNUSTEP + int fd = wl_event_loop_get_fd(_event_loop); + + CFSocketContext context = { + .version = 0, + .info = self, + .retain = NULL, + .release = NULL, + .copyDescription = NULL + }; + + _socket = CFSocketCreateWithNative( + NULL, + fd, + kCFSocketReadCallBack, + socketCallback, + &context + ); + _source = CFSocketCreateRunLoopSource(NULL, _socket, 0); +#endif + + return self; +} + +- (void) dealloc { +#ifndef OWL_PLATFORM_GNUSTEP + CFRelease(_source); + CFRelease(_socket); +#endif + [super dealloc]; +} + +- (void) addToRunLoop { +#ifndef OWL_PLATFORM_GNUSTEP + CFRunLoopAddSource(CFRunLoopGetCurrent(), _source, kCFRunLoopDefaultMode); +#else + int fd = wl_event_loop_get_fd(_event_loop); + + [[NSRunLoop currentRunLoop] addEvent: (void *) fd + type: ET_RDESC + watcher: self + forMode: NSDefaultRunLoopMode]; +#endif +} + +- (void) removeFromRunLoop { +#ifndef OWL_PLATFORM_GNUSTEP + CFRunLoopRemoveSource(CFRunLoopGetCurrent(), _source, kCFRunLoopDefaultMode); +#else + int fd = wl_event_loop_get_fd(_event_loop); + + [[NSRunLoop currentRunLoop] removeEvent: (void *) fd + type: ET_RDESC + forMode: NSDefaultRunLoopMode + all: YES]; +#endif +} + +@end diff --git a/Sources/Server/OwlServer.h b/Sources/Server/OwlServer.h new file mode 100644 index 0000000..84bc37e --- /dev/null +++ b/Sources/Server/OwlServer.h @@ -0,0 +1,37 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@class OwlRunLoopSource; + +@interface OwlServer : NSObject { + struct wl_display *_display; + OwlRunLoopSource *_runLoopSource; +} + ++ (OwlServer *) sharedServer; + +- (uint32_t) nextSerial; ++ (uint32_t) timestamp; + +- (void) flushClients; +- (void) flushClientsLater; + +@end diff --git a/Sources/Server/OwlServer.m b/Sources/Server/OwlServer.m new file mode 100644 index 0000000..4ebbcb8 --- /dev/null +++ b/Sources/Server/OwlServer.m @@ -0,0 +1,224 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlServer.h" +#import "OwlRunLoopSource.h" +#import "OwlFeatures.h" +#import "OwlCompositor.h" +#import "OwlSubcompositor.h" +#import "OwlWlShell.h" +#import "OwlZxdgShellV6.h" +#import "OwlXdgWmBase.h" +#import "OwlSeat.h" +#import "OwlWlDataDeviceManager.h" +#import "OwlZwlrDataControlManagerV1.h" +#import "OwlPasteboardDataDevice.h" +#import "OwlSelection.h" + +#ifdef OWL_PLATFORM_APPLE + #import "OwlZowlMachIpcV1.h" + #import "OwlZowlIOSurfaceManagerV1.h" +#endif + +@implementation OwlServer + +- (BOOL) setUpSocket { + // Set up a socket on the filesystem that the clients can connect + // to when they want to talk to us. Normally, it's placed at a path + // like /run/user/1000/wayland-0. Here, /run/user/1000 is the value + // of the XDG_RUNTIME_DIR environment variable, and wayland-0 is the + // WAYLAND_DISPLAY. libwayland-client tries to automatically pick + // an unused display number, but in order for this to work at all, + // XDG_RUNTIME_DIR has to be set, and the directory has to exist + // at that path, and we shouldbe able to write there. + const char *socket_name = wl_display_add_socket_auto(_display); + + if (socket_name == NULL) { + // So if that failed, let's display an error message to the user. + NSAlert *alert = [[NSAlert alloc] init]; + [alert setMessageText: @"Failed to grab a socket"]; + + // See if XDG_RUNTIME_DIR is even set. + NSDictionary *environment = [[NSProcessInfo processInfo] environment]; + NSString *runtimeDir = [environment objectForKey: @"XDG_RUNTIME_DIR"]; + if (runtimeDir == nil) { + [alert setInformativeText: @"XDG_RUNTIME_DIR is unset"]; + } else if (![[NSFileManager defaultManager] fileExistsAtPath: runtimeDir]) { + NSString *s = [NSString stringWithFormat: @"XDG_RUNTIME_DIR (%@) does not exist", runtimeDir]; + [alert setInformativeText: s]; + } + [alert runModal]; + + return NO; + } + + NSString *socketName = [NSString stringWithUTF8String: socket_name]; + NSLog(@"Running compositor on Wayland display %@", socketName); + return YES; +} + +- (id) init { + // When a Unix process tries to write into a broken pipe (one that + // has no readers attached to it anymore), the kernel sends it the + // SIGPIPE signal, whose default action is to kill the process. This + // makes some sense for command-line programs whose stdout is piped + // to another command that has already concluded it doesn't need to + // read any more of it, such as when piping a command into head(1), + // but not for a Wayland compositor trying to talk to a disconnected + // client. So ask the kernel to make this signal harmless for us. + signal(SIGPIPE, SIG_IGN); + + // Create the Wayland display. This does not yet set up a socket on + // the filesystem or start serving clients. + _display = wl_display_create(); + + // Wayland uses its own implementation of event loop (also known as + // run loop and main loop). Of course, only one event loop can actually + // serve as the *main* loop, but it's possible to integrate the two + // loops so that one of them (the Cocoa run loop) watches for the events + // the other one (the Wayland event loop) is interested in, and calls + // it back when these events happen. In Owl, this integration is + // implemented in the OwlRunLoopSource class. Set up that integration now. + struct wl_event_loop *event_loop = wl_display_get_event_loop(_display); + _runLoopSource = [[OwlRunLoopSource alloc] initWithEventLoop: event_loop]; + [_runLoopSource addToRunLoop]; + + // Now, try to set up a socket on the filesystem. This method will + // display error messages itself, so we just need to check its return + // code. + if (![self setUpSocket]) { + // We could not set up the socket. Give up and let the caller know. + [self release]; + return nil; + } + +#ifdef OWL_PLATFORM_APPLE + // On Darwin, check in with the bootstrap service. + [OwlZowlMachIpcV1 bootstrapCheckInWithName: @"io.github.bugaevc.Owl"]; +#endif + + // Enable the built-in implementation of wl_shm. Among other things, + // this does add the wl_shm global to the display. + wl_display_init_shm(_display); + + // Add various globals to the display. + [OwlCompositor addGlobalToDisplay: _display]; + [OwlSubcompositor addGlobalToDisplay: _display]; + [OwlWlShell addGlobalToDisplay: _display]; + [OwlZxdgShellV6 addGlobalToDisplay: _display]; + [OwlXdgWmBase addGlobalToDisplay: _display]; + [OwlWlDataDeviceManager addGlobalToDisplay: _display]; + [OwlSeat addGlobalToDisplay: _display]; + + [OwlZwlrDataControlManagerV1 addGlobalToDisplay: _display]; + +#ifdef OWL_PLATFORM_APPLE + // On Darwin, add some Mach-related globals. + [OwlZowlMachIpcV1 addGlobalToDisplay: _display]; + [OwlZowlIOSurfaceManagerV1 addGlobalToDisplay: _display]; +#endif + + // Create the pasteboard data device, telling it to connect + // the general Cocoa pasteboard to the Wayland clipboard. + [[OwlPasteboardDataDevice alloc] initWithPasteboard: [NSPasteboard generalPasteboard] + selection: [OwlSelection clipboard]]; + +#ifdef OWL_PLATFORM_GNUSTEP + // On GNUstep, create another pasteboard data device for the + // primary selection. Here, "Selection" is the pasteboard name + // that GNUstep handles specifically, mapping it to XA_PRIMARY. + // See https://github.com/gnustep/libs-back/blob/master/Tools/xpbs.m + // for more details. + [[OwlPasteboardDataDevice alloc] initWithPasteboard: [NSPasteboard pasteboardWithName: @"Selection"] + selection: [OwlSelection primary]]; +#endif + + return self; +} + +- (void) dealloc { + [_runLoopSource removeFromRunLoop]; + [_runLoopSource release]; + wl_display_destroy(_display); + [super dealloc]; +} + +- (uint32_t) nextSerial { + return wl_display_next_serial(_display); +} + +// Get the current timestamp suitable for using in Wayland events. +// +// The returned timestamp is in milliseconds. Wayland leaves +// the base unspecified (i.e. implementation-defined), so a +// compositor can pick whatever base is most convenient for +// its implementation. For us, it's the reference date used +// by -timeIntervalSinceReferenceDate, i.e. 1 January 2001. ++ (uint32_t) timestamp { + NSTimeInterval ti = [[NSDate date] timeIntervalSinceReferenceDate]; + return ti * 1000; +} + +// Explicitly flush our clients. +// +// Normally, this is done by OwlRunLoopSource after dispatching +// the events, so most request handlers don't have to call this +// explictly. This does have to be called explicitly upon sending +// Wayland events when handling a Cocoa event such as -mouseDown:. +// +// Please note that calling this may lead to crashes if a client +// connection is found to be broken, and its resources get destroyed +// on the spot; normally the code around the Cocoa event being +// handled doesn't expect the object to be destroyed immediately. +// To prevent this, call -flushClientsLater instead. +- (void) flushClients { + wl_display_flush_clients(_display); +} + +// Schedule to flush our clients sometime soon. +// +// This arranges to call -flushClients on the next iteration of the +// Cocoa run loop. See the comment on -flushClients for why you would +// want to use this method instead of that one. +- (void) flushClientsLater { + NSArray *modes = [NSArray arrayWithObject: NSDefaultRunLoopMode]; + NSRunLoop *loop = [NSRunLoop currentRunLoop]; + // The order argument below represents which order these delayed + // selectors should be executed in; lower values go first. We do + // not care, so pass some large number. + [loop performSelector: @selector(flushClients) + target: self + argument: nil + order: 1000 + modes: modes]; +} + +// Get the singleton serever instance. +// +// There's normally only one OwlServer object in the program, and it +// can be accessed using this method. This method will automatically +// create and initialize the server the first time it gets called. ++ (OwlServer *) sharedServer { + static OwlServer *shared; + if (shared == nil) { + shared = [OwlServer new]; + } + return shared; +} + +@end diff --git a/Sources/Server/main.m b/Sources/Server/main.m new file mode 100644 index 0000000..11dc3f0 --- /dev/null +++ b/Sources/Server/main.m @@ -0,0 +1,23 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> + +int main(int argc, char *argv[]) { + return NSApplicationMain(argc, (const char **) argv); +} diff --git a/Sources/Shell/OwlWindow.h b/Sources/Shell/OwlWindow.h new file mode 100644 index 0000000..5ae68ae --- /dev/null +++ b/Sources/Shell/OwlWindow.h @@ -0,0 +1,35 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> + + +@interface OwlWindow : NSWindow { + NSString *_title; +} + +- (id) initWithSize: (NSSize) size displaySSD: (BOOL) displaySSD; + +- (BOOL) displaySSD; +- (void) setDisplaySSD: (BOOL) value; + +- (IBAction) toggleDisplaySSD: (NSMenuItem *) sender; + +- (void) runInteractiveMove; + +@end diff --git a/Sources/Shell/OwlWindow.m b/Sources/Shell/OwlWindow.m new file mode 100644 index 0000000..78ccc56 --- /dev/null +++ b/Sources/Shell/OwlWindow.m @@ -0,0 +1,116 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlWindow.h" +#import <Cocoa/Cocoa.h> + +@implementation OwlWindow + ++ (NSUInteger) styleMaskWhenDisplayingSSD: (BOOL) displaySSD { + if (!displaySSD) { + return NSBorderlessWindowMask; + } + return NSTitledWindowMask | NSClosableWindowMask | + NSMiniaturizableWindowMask | NSResizableWindowMask; +} + +- (id) initWithSize: (NSSize) size displaySSD: (BOOL) displaySSD { + NSRect contentRect; + contentRect.origin = NSMakePoint(500, 500); + contentRect.size = size; + + NSUInteger styleMask = [OwlWindow styleMaskWhenDisplayingSSD: displaySSD]; + self = [super initWithContentRect: contentRect + styleMask: styleMask + backing: NSBackingStoreBuffered + defer: NO]; + + [self setOpaque: NO]; + [self setBackgroundColor: [NSColor clearColor]]; + [self setReleasedWhenClosed: NO]; + [self setAcceptsMouseMovedEvents: YES]; + + // Does not automatically happen for borderless windows. + [NSApp addWindowsItem: self title: @"Window" filename: NO]; + + return self; +} + +- (void) setTitle: (NSString *) newTitle { + newTitle = [newTitle retain]; + [_title release]; + _title = newTitle; + [super setTitle: newTitle]; + [NSApp changeWindowsItem: self title: newTitle filename: NO]; +} + +- (void) dealloc { + [_title release]; + [super dealloc]; +} + +- (BOOL) displaySSD { + return ([self styleMask] & NSTitledWindowMask) != 0; +} + +- (void) setDisplaySSD: (BOOL) displaySSD { + [self setStyleMask: [OwlWindow styleMaskWhenDisplayingSSD: displaySSD]]; + if (_title != nil) { + [self setTitle: _title]; + } +} + +- (IBAction) toggleDisplaySSD: (NSMenuItem *) sender { + BOOL displaySSD = ![self displaySSD]; + [self setDisplaySSD: displaySSD]; + [sender setState: displaySSD]; +} + +- (BOOL) canBecomeKeyWindow { + return YES; +} + +- (BOOL) canBecomeMainWindow { + return YES; +} + +- (void) runInteractiveMove { + NSPoint originalMouseLocation = [NSEvent mouseLocation]; + NSPoint originalOrigin = [self frame].origin; + NSEventMask mask = NSLeftMouseUpMask | NSMouseMovedMask | NSLeftMouseDraggedMask; + + while (YES) { + NSEvent *event = [NSApp nextEventMatchingMask: mask + untilDate: [NSDate distantFuture] + inMode: NSEventTrackingRunLoopMode + dequeue: YES]; + + if ([event type] == NSLeftMouseUp) { + break; + } + + NSPoint mouseLocation = [NSEvent mouseLocation]; + + NSPoint origin = originalOrigin; + origin.x += mouseLocation.x - originalMouseLocation.x; + origin.y += mouseLocation.y - originalMouseLocation.y; + [self setFrameOrigin: origin]; + } +} + +@end diff --git a/Sources/Shell/OwlWindowWrapper.h b/Sources/Shell/OwlWindowWrapper.h new file mode 100644 index 0000000..533386f --- /dev/null +++ b/Sources/Shell/OwlWindowWrapper.h @@ -0,0 +1,46 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import <Cocoa/Cocoa.h> +#import "OwlWindow.h" + +@interface OwlWindowWrapper : NSObject { + NSString *_title; + OwlWindow *_window; + NSView *_view; + NSSize _size; + id<NSWindowDelegate> _windowDelegate; +} + +- (OwlWindow *) window; + +- (void) map; +- (void) unmap; +- (void) close; + +- (void) minimize; +- (void) maximize; +- (void) unmaximize; + +- (void) setContentSize: (NSSize) size; +- (void) setTitle: (NSString *) title; +- (void) setView: (NSView *) view; +- (void) setWindowDelegate: (id<NSWindowDelegate>) delegate; + + +@end diff --git a/Sources/Shell/OwlWindowWrapper.m b/Sources/Shell/OwlWindowWrapper.m new file mode 100644 index 0000000..c29fa8a --- /dev/null +++ b/Sources/Shell/OwlWindowWrapper.m @@ -0,0 +1,109 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlWindowWrapper.h" +#import "OwlWindow.h" +#import <Cocoa/Cocoa.h> + +@implementation OwlWindowWrapper + +- (void) dealloc { + [_window release]; + [_title release]; + [_view release]; + [_windowDelegate release]; + [super dealloc]; +} + +- (void) createWindow { + _window = [[OwlWindow alloc] initWithSize: _size displaySSD: NO]; + + if (_title != nil) { + [_window setTitle: _title]; + } + if (_view != nil) { + [[_window contentView] addSubview: _view]; + [_window makeFirstResponder: _view]; + } + [_window setDelegate: _windowDelegate]; +} + +- (void) map { + if (_window == nil) { + [self createWindow]; + } + [_window makeKeyAndOrderFront: self]; +} + +- (void) unmap { + [_window orderOut: self]; +} + +- (void) close { + [_window close]; +} + +- (void) minimize { + [_window miniaturize: self]; +} + +- (void) maximize { + if (![_window isZoomed]) { + [_window zoom: self]; + } +} + +- (void) unmaximize { + if ([_window isZoomed]) { + [_window zoom: self]; + } +} + +- (OwlWindow *) window { + return _window; +} + +- (void) setContentSize: (NSSize) size { + _size = size; + [_window setContentSize: _size]; +} + +- (void) setTitle: (NSString *) title { + [title retain]; + [_title release]; + _title = title; + [_window setTitle: title]; +} + +- (void) setView: (NSView *) view { + [view retain]; + [_view removeFromSuperview]; + [_view release]; + _view = view; + [[_window contentView] addSubview: view]; + [_window makeFirstResponder: view]; +} + +- (void) setWindowDelegate: (id<NSWindowDelegate>) delegate { + [delegate retain]; + [_windowDelegate release]; + _windowDelegate = delegate; + [_window setDelegate: delegate]; +} + +@end diff --git a/Sources/Shell/OwlWlShell.h b/Sources/Shell/OwlWlShell.h new file mode 100644 index 0000000..2f7156e --- /dev/null +++ b/Sources/Shell/OwlWlShell.h @@ -0,0 +1,27 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@interface OwlWlShell : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + +@end diff --git a/Sources/Shell/OwlWlShell.m b/Sources/Shell/OwlWlShell.m new file mode 100644 index 0000000..76ad4c8 --- /dev/null +++ b/Sources/Shell/OwlWlShell.m @@ -0,0 +1,83 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlWlShell.h" +#import <wayland-server.h> +#import "OwlSurface.h" +#import "OwlWlShellSurface.h" + +@implementation OwlWlShell + +static void shell_get_shell_surface_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id, + struct wl_resource *surface_resource +) { + struct wl_resource *shell_surface_resource = wl_resource_create( + client, + &wl_shell_surface_interface, + 1, + id + ); + + OwlSurface *surface = wl_resource_get_user_data(surface_resource); + [[[OwlWlShellSurface alloc] initWithResource: shell_surface_resource + surface: surface] release]; +} + +static const struct wl_shell_interface shell_impl = { + .get_shell_surface = shell_get_shell_surface_handler +}; + +static void wl_shell_destroy(struct wl_resource *resource) { + OwlWlShell *self = wl_resource_get_user_data(resource); + [self release]; +} + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &shell_impl, + [self retain], + wl_shell_destroy + ); + return self; +} + +static void shell_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &wl_shell_interface, + version, + id + ); + [[[OwlWlShell alloc] initWithResource: resource] release]; +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create(display, &wl_shell_interface, 1, NULL, shell_bind); +} + +@end diff --git a/Sources/Shell/OwlWlShellSurface.h b/Sources/Shell/OwlWlShellSurface.h new file mode 100644 index 0000000..75e6a63 --- /dev/null +++ b/Sources/Shell/OwlWlShellSurface.h @@ -0,0 +1,43 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSurface.h" +#import "OwlWindowWrapper.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +enum OwlWlShellSurfaceMode { + OWL_WL_SHELL_SURFACE_MODE_NONE = 0, + OWL_WL_SHELL_SURFACE_MODE_TOPLEVEL, + OWL_WL_SHELL_SURFACE_MODE_TRANSIENT, + OWL_WL_SHELL_SURFACE_MODE_FULLSCREEN, + OWL_WL_SHELL_SURFACE_MODE_POPUP, + OWL_WL_SHELL_SURFACE_MODE_MAXIMIZED +}; + +@interface OwlWlShellSurface : NSObject<OwlSurfaceRole> { + struct wl_resource *_resource; + OwlSurface *_surface; + OwlWindowWrapper *_window; + enum OwlWlShellSurfaceMode _mode; +} + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface; + +@end diff --git a/Sources/Shell/OwlWlShellSurface.m b/Sources/Shell/OwlWlShellSurface.m new file mode 100644 index 0000000..c3f225a --- /dev/null +++ b/Sources/Shell/OwlWlShellSurface.m @@ -0,0 +1,103 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlWlShellSurface.h" +#import "OwlSurface.h" +#import "OwlWindowWrapper.h" +#import <wayland-server.h> + +@implementation OwlWlShellSurface + +static void shell_surface_destroy(struct wl_resource *resource) { + OwlWlShellSurface *self = wl_resource_get_user_data(resource); + [self->_window close]; + [self release]; +} + +static void shell_surface_move_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *seat_resource, + uint32_t serial +) { + OwlWlShellSurface *self = wl_resource_get_user_data(resource); + [[self->_window window] runInteractiveMove]; +} + +static void shell_surface_set_toplevel_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlWlShellSurface *self = wl_resource_get_user_data(resource); + self->_mode = OWL_WL_SHELL_SURFACE_MODE_TOPLEVEL; +} + +static void shell_surface_set_title_handler( + struct wl_client *client, + struct wl_resource *resource, + const char *raw_title +) { + OwlWlShellSurface *self = wl_resource_get_user_data(resource); + [self->_window setTitle: [NSString stringWithUTF8String: raw_title]]; +} + +static const struct wl_shell_surface_interface shell_surface_interface = { + .set_toplevel = shell_surface_set_toplevel_handler, + .set_title = shell_surface_set_title_handler + // TODO +}; + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface +{ + _resource = resource; + _surface = [surface retain]; + + [surface setRole: self]; + _window = [OwlWindowWrapper new]; + [_window setView: surface]; + + wl_resource_set_implementation( + resource, + &shell_surface_interface, + [self retain], + shell_surface_destroy + ); + return self; +} + +- (void) dealloc { + [_surface release]; + [_window release]; + [super dealloc]; +} + +- (void) map { + [self update]; + [_window map]; +} + +- (void) unmap { + [_window unmap]; +} + +- (void) update { + [_window setContentSize: [_surface bounds].size]; +} + +@end diff --git a/Sources/Shell/OwlXdgSurface.h b/Sources/Shell/OwlXdgSurface.h new file mode 100644 index 0000000..233714d --- /dev/null +++ b/Sources/Shell/OwlXdgSurface.h @@ -0,0 +1,35 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSurface.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@interface OwlXdgSurface : NSObject { + struct wl_resource *_resource; + OwlSurface *_surface; +} + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface; + +- (void) sendConfigure; + +- (NSSize) geometrySizeForBufferSize: (NSSize) size; + +@end diff --git a/Sources/Shell/OwlXdgSurface.m b/Sources/Shell/OwlXdgSurface.m new file mode 100644 index 0000000..71b974c --- /dev/null +++ b/Sources/Shell/OwlXdgSurface.m @@ -0,0 +1,119 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlXdgSurface.h" +#import "OwlSurface.h" +#import "OwlXdgToplevel.h" +#import "xdg-shell.h" +#import <wayland-server.h> + + +@implementation OwlXdgSurface + +static void xdg_surface_destroy(struct wl_resource *resource) { + OwlXdgSurface *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void xdg_surface_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void xdg_surface_get_xdg_toplevel_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + OwlXdgSurface *self = wl_resource_get_user_data(resource); + struct wl_resource *xdg_toplevel_resource = wl_resource_create( + client, + &xdg_toplevel_interface, + 1, + id + ); + [[[OwlXdgToplevel alloc] initWithResource: xdg_toplevel_resource + surface: self->_surface + xdgSurface: self] release]; +} + +static void xdg_surface_ack_configure_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t serial +) { + // TODO +} + +static void xdg_surface_set_window_geometry_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t x, + int32_t y, + int32_t width, + int32_t height +) { + OwlXdgSurface *self = wl_resource_get_user_data(resource); + NSRect rect = NSMakeRect(x, y, width, height); + [self->_surface setPendingGeometry: rect]; +} + +static const struct xdg_surface_interface xdg_surface_impl = { + .destroy = xdg_surface_destroy_handler, + .get_toplevel = xdg_surface_get_xdg_toplevel_handler, + .ack_configure = xdg_surface_ack_configure_handler, + .set_window_geometry = xdg_surface_set_window_geometry_handler + // TODO +}; + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface +{ + _resource = resource; + _surface = [surface retain]; + wl_resource_set_implementation( + resource, + &xdg_surface_impl, + [self retain], + xdg_surface_destroy + ); + return self; +} + +- (void) dealloc { + [_surface release]; + [super dealloc]; +} + +- (void) sendConfigure { + struct wl_client *client = wl_resource_get_client(_resource); + struct wl_display *display = wl_client_get_display(client); + uint32_t serial = wl_display_next_serial(display); + xdg_surface_send_configure(_resource, serial); +} + +- (NSSize) geometrySizeForBufferSize: (NSSize) size { + NSSize adj = [_surface geometrySizeAdjustements]; + size.width -= adj.width; + size.height -= adj.height; + return size; +} + +@end diff --git a/Sources/Shell/OwlXdgToplevel.h b/Sources/Shell/OwlXdgToplevel.h new file mode 100644 index 0000000..36726fa --- /dev/null +++ b/Sources/Shell/OwlXdgToplevel.h @@ -0,0 +1,39 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSurface.h" +#import "OwlWindowWrapper.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@class OwlXdgSurface; + +@interface OwlXdgToplevel : NSObject<OwlSurfaceRole, NSWindowDelegate> { + struct wl_resource *_resource; + OwlSurface *_surface; + OwlXdgSurface *_xdgSurface; + BOOL _configured; + BOOL _activated, _fullscreen, _resizing, _maximized; + OwlWindowWrapper *_window; +} + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface + xdgSurface: (OwlXdgSurface *) xdgSurface; + +@end diff --git a/Sources/Shell/OwlXdgToplevel.m b/Sources/Shell/OwlXdgToplevel.m new file mode 100644 index 0000000..ecd2f43 --- /dev/null +++ b/Sources/Shell/OwlXdgToplevel.m @@ -0,0 +1,276 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlXdgToplevel.h" +#import "OwlSurface.h" +#import "OwlXdgSurface.h" +#import "OwlServer.h" +#import "OwlKeyboard.h" +#import "OwlWlDataDevice.h" +#import "xdg-shell.h" +#import <wayland-server.h> + + +@implementation OwlXdgToplevel + +static void xdg_toplevel_destroy(struct wl_resource *resource) { + OwlXdgToplevel *self = wl_resource_get_user_data(resource); + [self->_window close]; + [self release]; +} + +static void xdg_toplevel_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void xdg_toplevel_set_parent_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *parent_resource +) { + // TODO +} + +static void xdg_toplevel_set_title_handler( + struct wl_client *client, + struct wl_resource *resource, + const char *raw_title +) { + OwlXdgToplevel *self = wl_resource_get_user_data(resource); + [self->_window setTitle: [NSString stringWithUTF8String: raw_title]]; +} + +static void xdg_toplevel_set_app_id_handler( + struct wl_client *client, + struct wl_resource *resource, + const char *raw_app_id +) { + // Do nothing. +} + +static void xdg_toplevel_move_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *seat_resource, + uint32_t serial +) { + OwlXdgToplevel *self = wl_resource_get_user_data(resource); + [[self->_window window] runInteractiveMove]; +} + +static void xdg_toplevel_set_max_size_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t width, + int32_t height +) { + // TODO +} + +static void xdg_toplevel_set_min_size_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t width, + int32_t height +) { + // TODO +} + +static void xdg_toplevel_set_minimized_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlXdgToplevel *self = wl_resource_get_user_data(resource); + [self->_window minimize]; +} + +static void xdg_toplevel_set_maximized_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlXdgToplevel *self = wl_resource_get_user_data(resource); + [self->_window maximize]; +} + +static void xdg_toplevel_unset_maximized_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlXdgToplevel *self = wl_resource_get_user_data(resource); + [self->_window unmaximize]; +} + +static const struct xdg_toplevel_interface xdg_toplevel_impl = { + .destroy = xdg_toplevel_destroy_handler, + .set_parent = xdg_toplevel_set_parent_handler, + .set_title = xdg_toplevel_set_title_handler, + .set_app_id = xdg_toplevel_set_app_id_handler, + .move = xdg_toplevel_move_handler, + .set_max_size = xdg_toplevel_set_max_size_handler, + .set_min_size = xdg_toplevel_set_min_size_handler, + .set_minimized = xdg_toplevel_set_minimized_handler, + .set_maximized = xdg_toplevel_set_maximized_handler, + .unset_maximized = xdg_toplevel_unset_maximized_handler + // TODO +}; + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface + xdgSurface: (OwlXdgSurface *) xdgSurface +{ + _resource = resource; + _surface = [surface retain]; + _xdgSurface = xdgSurface; + + [surface setRole: self]; + _window = [OwlWindowWrapper new]; + [_window setView: surface]; + [_window setWindowDelegate: self]; + + wl_resource_set_implementation( + resource, + &xdg_toplevel_impl, + [self retain], + xdg_toplevel_destroy + ); + + return self; +} + +- (void) dealloc { + [_surface release]; + [_window release]; + [super dealloc]; +} + +- (struct wl_array) makeStates { + struct wl_array states; + wl_array_init(&states); + +#define append(condition, value) \ + if (condition) { \ + void *ptr = wl_array_add( \ + &states, \ + sizeof(enum xdg_toplevel_state) \ + ); \ + *(enum xdg_toplevel_state *) ptr = (value); \ + } else + + append(_activated, XDG_TOPLEVEL_STATE_ACTIVATED); + append(_fullscreen, XDG_TOPLEVEL_STATE_FULLSCREEN); + append(_resizing, XDG_TOPLEVEL_STATE_RESIZING); + append(_maximized, XDG_TOPLEVEL_STATE_MAXIMIZED); + +#undef append + + return states; +} + +- (void) sendConfigureWithSize: (NSSize) size { + struct wl_array states = [self makeStates]; + xdg_toplevel_send_configure( + _resource, + size.width, + size.height, + &states + ); + [_xdgSurface sendConfigure]; + wl_array_release(&states); + _configured = YES; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (OwlKeyboard *) keyboard { + struct wl_client *client = wl_resource_get_client(_resource); + return [OwlKeyboard keyboardForClient: client]; +} + +- (OwlWlDataDevice *) dataDevice { + struct wl_client *client = wl_resource_get_client(_resource); + return [OwlWlDataDevice dataDeviceForClient: client]; +} + +- (uint32_t) serial { + struct wl_client *client = wl_resource_get_client(_resource); + struct wl_display *display = wl_client_get_display(client); + return wl_display_next_serial(display); +} + +- (void) map { + [self update]; + [_window map]; +} + +- (void) unmap { + if (!_configured) { + [self sendConfigureWithSize: NSZeroSize]; + return; + } + [_window unmap]; +} + +- (void) update { + [_window setContentSize: [_surface bounds].size]; +} + +- (void) windowDidResize: (NSNotification *) notification { + NSWindow *w = [notification object]; + _maximized = NO; // [w isZoomed]; + NSRect frame = [w frame]; + NSSize s = [w contentRectForFrameRect: frame].size; + s = [_xdgSurface geometrySizeForBufferSize: s]; + [self sendConfigureWithSize: s]; +} + +- (BOOL) windowShouldClose: (NSWindow *) w { + xdg_toplevel_send_close(_resource); + [[OwlServer sharedServer] flushClientsLater]; + return NO; +} + +- (void) windowWillClose: (NSNotification *) notification { + // Unsubscribe so we don't get didResignMain. + [_window setWindowDelegate: nil]; +} + +- (void) windowDidBecomeMain: (NSNotification *) notification { + _activated = YES; + [self sendConfigureWithSize: NSZeroSize]; +} + +- (void) windowDidResignMain: (NSNotification *) notification { + _activated = NO; + [self sendConfigureWithSize: NSZeroSize]; +} + +- (void) windowDidBecomeKey: (NSNotification *) notification { + [[self keyboard] sendEnterSurface: _surface]; + [[self dataDevice] focused]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) windowDidResignKey: (NSNotification *) notification { + [[self keyboard] sendLeaveSurface: _surface]; + [[self dataDevice] unfocused]; + [[OwlServer sharedServer] flushClientsLater]; +} + +@end diff --git a/Sources/Shell/OwlXdgWmBase.h b/Sources/Shell/OwlXdgWmBase.h new file mode 100644 index 0000000..6ab2ea7 --- /dev/null +++ b/Sources/Shell/OwlXdgWmBase.h @@ -0,0 +1,27 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@interface OwlXdgWmBase : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + +@end diff --git a/Sources/Shell/OwlXdgWmBase.m b/Sources/Shell/OwlXdgWmBase.m new file mode 100644 index 0000000..23a5c31 --- /dev/null +++ b/Sources/Shell/OwlXdgWmBase.m @@ -0,0 +1,101 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlXdgWmBase.h" +#import "OwlSurface.h" +#import "OwlXdgSurface.h" +#import "xdg-shell.h" +#import <wayland-server.h> + +@implementation OwlXdgWmBase + +static void xdg_wm_base_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void xdg_wm_base_destroy( + struct wl_resource *resource +) { + OwlXdgWmBase *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void xdg_wm_base_get_xdg_surface( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id, + struct wl_resource *surface_resource +) { + struct wl_resource *xdg_surface_resource = wl_resource_create( + client, + &xdg_surface_interface, + 1, + id + ); + + OwlSurface *surface = wl_resource_get_user_data(surface_resource); + [[[OwlXdgSurface alloc] initWithResource: xdg_surface_resource + surface: surface] release]; +} + +static const struct xdg_wm_base_interface xdg_wm_base_impl = { + .destroy = xdg_wm_base_destroy_handler, + .get_xdg_surface = xdg_wm_base_get_xdg_surface + // TODO +}; + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &xdg_wm_base_impl, + [self retain], + NULL + ); + return self; +} + +static void xdg_wm_base_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &xdg_wm_base_interface, + version, + id + ); + [[[OwlXdgWmBase alloc] initWithResource: resource] release]; +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create( + display, + &xdg_wm_base_interface, + 1, + NULL, + xdg_wm_base_bind + ); +} + +@end diff --git a/Sources/Shell/OwlZxdgShellV6.h b/Sources/Shell/OwlZxdgShellV6.h new file mode 100644 index 0000000..272daf4 --- /dev/null +++ b/Sources/Shell/OwlZxdgShellV6.h @@ -0,0 +1,28 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlGlobal.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + + +@interface OwlZxdgShellV6 : NSObject <OwlGlobal> { + struct wl_resource *_resource; +} + +@end diff --git a/Sources/Shell/OwlZxdgShellV6.m b/Sources/Shell/OwlZxdgShellV6.m new file mode 100644 index 0000000..bbb6c7e --- /dev/null +++ b/Sources/Shell/OwlZxdgShellV6.m @@ -0,0 +1,103 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlZxdgShellV6.h" +#import "OwlSurface.h" +#import "OwlZxdgSurfaceV6.h" +#import "xdg-shell-unstable-v6.h" +#import <wayland-server.h> + +@implementation OwlZxdgShellV6 + +static void xdg_shell_v6_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void xdg_shell_v6_destroy( + struct wl_resource *resource +) { + OwlZxdgShellV6 *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void xdg_shell_v6_get_xdg_surface( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id, + struct wl_resource *surface_resource +) { + struct wl_resource *xdg_surface_resource = wl_resource_create( + client, + &zxdg_surface_v6_interface, + 1, + id + ); + + OwlSurface *surface = wl_resource_get_user_data(surface_resource); + [[[OwlZxdgSurfaceV6 alloc] initWithResource: xdg_surface_resource + surface: surface] release]; +} + +static const struct zxdg_shell_v6_interface xdg_shell_v6_impl = { + .destroy = xdg_shell_v6_destroy_handler, + .get_xdg_surface = xdg_shell_v6_get_xdg_surface + // TODO +}; + + +- (id) initWithResource: (struct wl_resource *) resource { + _resource = resource; + wl_resource_set_implementation( + resource, + &xdg_shell_v6_impl, + [self retain], + NULL + ); + return self; +} + +static void xdg_shell_v6_bind( + struct wl_client *client, + void *data, + uint32_t version, + uint32_t id +) { + struct wl_resource *resource = wl_resource_create( + client, + &zxdg_shell_v6_interface, + version, + id + ); + [[[OwlZxdgShellV6 alloc] initWithResource: resource] release]; + // TODO: destroy? +} + ++ (void) addGlobalToDisplay: (struct wl_display *) display { + wl_global_create( + display, + &zxdg_shell_v6_interface, + 1, + NULL, + xdg_shell_v6_bind + ); +} + +@end diff --git a/Sources/Shell/OwlZxdgSurfaceV6.h b/Sources/Shell/OwlZxdgSurfaceV6.h new file mode 100644 index 0000000..7908538 --- /dev/null +++ b/Sources/Shell/OwlZxdgSurfaceV6.h @@ -0,0 +1,35 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSurface.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@interface OwlZxdgSurfaceV6 : NSObject { + struct wl_resource *_resource; + OwlSurface *_surface; +} + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface; + +- (void) sendConfigure; + +- (NSSize) geometrySizeForBufferSize: (NSSize) size; + +@end diff --git a/Sources/Shell/OwlZxdgSurfaceV6.m b/Sources/Shell/OwlZxdgSurfaceV6.m new file mode 100644 index 0000000..749668d --- /dev/null +++ b/Sources/Shell/OwlZxdgSurfaceV6.m @@ -0,0 +1,119 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlZxdgSurfaceV6.h" +#import "OwlSurface.h" +#import "OwlZxdgToplevelV6.h" +#import "xdg-shell-unstable-v6.h" +#import <wayland-server.h> + + +@implementation OwlZxdgSurfaceV6 + +static void xdg_surface_v6_destroy(struct wl_resource *resource) { + OwlZxdgSurfaceV6 *self = wl_resource_get_user_data(resource); + [self release]; +} + +static void xdg_surface_v6_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void xdg_surface_v6_get_xdg_toplevel_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t id +) { + OwlZxdgSurfaceV6 *self = wl_resource_get_user_data(resource); + struct wl_resource *xdg_toplevel_resource = wl_resource_create( + client, + &zxdg_toplevel_v6_interface, + 1, + id + ); + [[[OwlZxdgToplevelV6 alloc] initWithResource: xdg_toplevel_resource + surface: self->_surface + xdgSurface: self] release]; +} + +static void xdg_surface_v6_ack_configure_handler( + struct wl_client *client, + struct wl_resource *resource, + uint32_t serial +) { + // TODO +} + +static void xdg_surface_v6_set_window_geometry_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t x, + int32_t y, + int32_t width, + int32_t height +) { + OwlZxdgSurfaceV6 *self = wl_resource_get_user_data(resource); + NSRect rect = NSMakeRect(x, y, width, height); + [self->_surface setPendingGeometry: rect]; +} + +static const struct zxdg_surface_v6_interface xdg_surface_v6_impl = { + .destroy = xdg_surface_v6_destroy_handler, + .get_toplevel = xdg_surface_v6_get_xdg_toplevel_handler, + .ack_configure = xdg_surface_v6_ack_configure_handler, + .set_window_geometry = xdg_surface_v6_set_window_geometry_handler + // TODO +}; + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface +{ + _resource = resource; + _surface = [surface retain]; + wl_resource_set_implementation( + resource, + &xdg_surface_v6_impl, + [self retain], + xdg_surface_v6_destroy + ); + return self; +} + +- (void) dealloc { + [_surface release]; + [super dealloc]; +} + +- (void) sendConfigure { + struct wl_client *client = wl_resource_get_client(_resource); + struct wl_display *display = wl_client_get_display(client); + uint32_t serial = wl_display_next_serial(display); + zxdg_surface_v6_send_configure(_resource, serial); +} + +- (NSSize) geometrySizeForBufferSize: (NSSize) size { + NSSize adj = [_surface geometrySizeAdjustements]; + size.width -= adj.width; + size.height -= adj.height; + return size; +} + +@end diff --git a/Sources/Shell/OwlZxdgToplevelV6.h b/Sources/Shell/OwlZxdgToplevelV6.h new file mode 100644 index 0000000..5fd26cd --- /dev/null +++ b/Sources/Shell/OwlZxdgToplevelV6.h @@ -0,0 +1,39 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlSurface.h" +#import "OwlWindowWrapper.h" +#import <Cocoa/Cocoa.h> +#import <wayland-server.h> + +@class OwlZxdgSurfaceV6; + +@interface OwlZxdgToplevelV6 : NSObject<OwlSurfaceRole, NSWindowDelegate> { + struct wl_resource *_resource; + OwlSurface *_surface; + OwlZxdgSurfaceV6 *_xdgSurface; + BOOL _configured; + BOOL _activated, _fullscreen, _resizing, _maximized; + OwlWindowWrapper *_window; +} + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface + xdgSurface: (OwlZxdgSurfaceV6 *) xdgSurface; + +@end diff --git a/Sources/Shell/OwlZxdgToplevelV6.m b/Sources/Shell/OwlZxdgToplevelV6.m new file mode 100644 index 0000000..359b675 --- /dev/null +++ b/Sources/Shell/OwlZxdgToplevelV6.m @@ -0,0 +1,276 @@ +/* This file is part of Owl. + * + * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> + * + * Owl 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. + * + * Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + */ + +#import "OwlZxdgToplevelV6.h" +#import "OwlSurface.h" +#import "OwlZxdgSurfaceV6.h" +#import "OwlServer.h" +#import "OwlKeyboard.h" +#import "OwlWlDataDevice.h" +#import "xdg-shell-unstable-v6.h" +#import <wayland-server.h> + + +@implementation OwlZxdgToplevelV6 + +static void xdg_toplevel_v6_destroy(struct wl_resource *resource) { + OwlZxdgToplevelV6 *self = wl_resource_get_user_data(resource); + [self->_window close]; + [self release]; +} + +static void xdg_toplevel_v6_destroy_handler( + struct wl_client *client, + struct wl_resource *resource +) { + wl_resource_destroy(resource); +} + +static void xdg_toplevel_v6_set_parent_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *parent_resource +) { + // TODO +} + +static void xdg_toplevel_v6_set_title_handler( + struct wl_client *client, + struct wl_resource *resource, + const char *raw_title +) { + OwlZxdgToplevelV6 *self = wl_resource_get_user_data(resource); + [self->_window setTitle: [NSString stringWithUTF8String: raw_title]]; +} + +static void xdg_toplevel_v6_set_app_id_handler( + struct wl_client *client, + struct wl_resource *resource, + const char *raw_app_id +) { + // Do nothing. +} + +static void xdg_toplevel_v6_move_handler( + struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *seat_resource, + uint32_t serial +) { + OwlZxdgToplevelV6 *self = wl_resource_get_user_data(resource); + [[self->_window window] runInteractiveMove]; +} + +static void xdg_toplevel_v6_set_max_size_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t width, + int32_t height +) { + // TODO +} + +static void xdg_toplevel_v6_set_min_size_handler( + struct wl_client *client, + struct wl_resource *resource, + int32_t width, + int32_t height +) { + // TODO +} + +static void xdg_toplevel_v6_set_minimized_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlZxdgToplevelV6 *self = wl_resource_get_user_data(resource); + [self->_window minimize]; +} + +static void xdg_toplevel_v6_set_maximized_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlZxdgToplevelV6 *self = wl_resource_get_user_data(resource); + [self->_window maximize]; +} + +static void xdg_toplevel_v6_unset_maximized_handler( + struct wl_client *client, + struct wl_resource *resource +) { + OwlZxdgToplevelV6 *self = wl_resource_get_user_data(resource); + [self->_window unmaximize]; +} + +static const struct zxdg_toplevel_v6_interface xdg_toplevel_v6_impl = { + .destroy = xdg_toplevel_v6_destroy_handler, + .set_parent = xdg_toplevel_v6_set_parent_handler, + .set_title = xdg_toplevel_v6_set_title_handler, + .set_app_id = xdg_toplevel_v6_set_app_id_handler, + .move = xdg_toplevel_v6_move_handler, + .set_max_size = xdg_toplevel_v6_set_max_size_handler, + .set_min_size = xdg_toplevel_v6_set_min_size_handler, + .set_minimized = xdg_toplevel_v6_set_minimized_handler, + .set_maximized = xdg_toplevel_v6_set_maximized_handler, + .unset_maximized = xdg_toplevel_v6_unset_maximized_handler + // TODO +}; + +- (id) initWithResource: (struct wl_resource *) resource + surface: (OwlSurface *) surface + xdgSurface: (OwlZxdgSurfaceV6 *) xdgSurface +{ + _resource = resource; + _surface = [surface retain]; + _xdgSurface = xdgSurface; + + [surface setRole: self]; + _window = [OwlWindowWrapper new]; + [_window setView: surface]; + [_window setWindowDelegate: self]; + + wl_resource_set_implementation( + resource, + &xdg_toplevel_v6_impl, + [self retain], + xdg_toplevel_v6_destroy + ); + + return self; +} + +- (void) dealloc { + [_surface release]; + [_window release]; + [super dealloc]; +} + +- (struct wl_array) makeStates { + struct wl_array states; + wl_array_init(&states); + +#define append(condition, value) \ + if (condition) { \ + void *ptr = wl_array_add( \ + &states, \ + sizeof(enum zxdg_toplevel_v6_state) \ + ); \ + *(enum zxdg_toplevel_v6_state *) ptr = (value); \ + } else + + append(_activated, ZXDG_TOPLEVEL_V6_STATE_ACTIVATED); + append(_fullscreen, ZXDG_TOPLEVEL_V6_STATE_FULLSCREEN); + append(_resizing, ZXDG_TOPLEVEL_V6_STATE_RESIZING); + append(_maximized, ZXDG_TOPLEVEL_V6_STATE_MAXIMIZED); + +#undef append + + return states; +} + +- (void) sendConfigureWithSize: (NSSize) size { + struct wl_array states = [self makeStates]; + zxdg_toplevel_v6_send_configure( + _resource, + size.width, + size.height, + &states + ); + [_xdgSurface sendConfigure]; + wl_array_release(&states); + _configured = YES; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (OwlKeyboard *) keyboard { + struct wl_client *client = wl_resource_get_client(_resource); + return [OwlKeyboard keyboardForClient: client]; +} + +- (OwlWlDataDevice *) dataDevice { + struct wl_client *client = wl_resource_get_client(_resource); + return [OwlWlDataDevice dataDeviceForClient: client]; +} + +- (uint32_t) serial { + struct wl_client *client = wl_resource_get_client(_resource); + struct wl_display *display = wl_client_get_display(client); + return wl_display_next_serial(display); +} + +- (void) map { + [self update]; + [_window map]; +} + +- (void) unmap { + if (!_configured) { + [self sendConfigureWithSize: NSZeroSize]; + return; + } + [_window unmap]; +} + +- (void) update { + [_window setContentSize: [_surface bounds].size]; +} + +- (void) windowDidResize: (NSNotification *) notification { + NSWindow *w = [notification object]; + _maximized = NO; // [w isZoomed]; + NSRect frame = [w frame]; + NSSize s = [w contentRectForFrameRect: frame].size; + s = [_xdgSurface geometrySizeForBufferSize: s]; + [self sendConfigureWithSize: s]; +} + +- (BOOL) windowShouldClose: (NSWindow *) w { + zxdg_toplevel_v6_send_close(_resource); + [[OwlServer sharedServer] flushClientsLater]; + return NO; +} + +- (void) windowWillClose: (NSNotification *) notification { + // Unsubscribe so we don't get didResignMain. + [_window setWindowDelegate: nil]; +} + +- (void) windowDidBecomeMain: (NSNotification *) notification { + _activated = YES; + [self sendConfigureWithSize: NSZeroSize]; +} + +- (void) windowDidResignMain: (NSNotification *) notification { + _activated = NO; + [self sendConfigureWithSize: NSZeroSize]; +} + +- (void) windowDidBecomeKey: (NSNotification *) notification { + [[self keyboard] sendEnterSurface: _surface]; + [[self dataDevice] focused]; + [[OwlServer sharedServer] flushClientsLater]; +} + +- (void) windowDidResignKey: (NSNotification *) notification { + [[self keyboard] sendLeaveSurface: _surface]; + [[self dataDevice] unfocused]; + [[OwlServer sharedServer] flushClientsLater]; +} + +@end diff --git a/configure b/configure new file mode 100755 index 0000000..95a3a55 --- /dev/null +++ b/configure @@ -0,0 +1,222 @@ +#! /bin/sh +# +# This file is part of Owl. +# +# Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com> +# +# Owl 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. +# +# Owl 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 Owl. If not, see <http://www.gnu.org/licenses/>. + +# These are the environment variables that +# the user can set to affect this script's +# output. +CC="${CC:-cc}" +CFLAGS="${CFLAGS:-}" +LDFLAGS="${LDFLAGS:-}" +if [ "$(uname)" = Darwin ]; then + LIBS=${LIBS:-"-l wayland-server -framework Cocoa -framework OpenGL -framework IOSurface"} +else + LIBS=${LIBS:-"-l wayland-server -l gnustep-gui -l gnustep-base -l objc"} +fi + +# Find the root directory based on where this +# script itself is located. It is expected that +# the current directory is the build directory. +root=$(dirname $0) +echo "Owl root directory detected as $root" >&2 + +if [ "$root" = . ]; then + echo "Refusing an in-source build" >&2 + echo "Please create a separate build directory" >&2 + exit 1 +fi + +# Redirect this script's standard output to Makefile. +# All the following commands inherit it implicitly. +exec > Makefile + +echo "# This makefile was generated by running $0 $*" + +# Essentially forward-declare the default target. +# Makefile uses the first target in the Makefile +# as the default target to make; but we would like +# to only write out the rule for the default target +# once we visit all the individual targets, if +# only to prepare the list of dependencies of the +# default target. So define a default target named +# "all" that forwards to a target named "app" that +# we will define later near the end. +echo "all: app" +echo + +# Find the list of source code directories. +dirs=$(ls "$root/Sources" | grep -Fv .) + +includes="-I Protocol/ -I $root/Sources/Protocol/" +headers="" +objs="" +generated="" +resources="" + +# Go over the Wayland protocols, generate header and source +# files for them, and build those source files. +mkdir -p Protocol +for xml in $(ls "$root/Sources/Protocol" | grep -F .xml); do + header="Protocol/${xml%.xml}.h" + code="Protocol/${xml%.xml}.c" + obj="Protocol/${xml%.xml}.o" + headers="$headers $header" + objs="$objs $obj" + generated="$generated $header $code" + echo "$header: $root/Sources/Protocol/$xml" + echo ' '"wayland-scanner server-header $root/Sources/Protocol/$xml $header" + echo + echo "$code: $root/Sources/Protocol/$xml" + echo ' '"wayland-scanner private-code $root/Sources/Protocol/$xml $code" + echo + echo "$obj: $code" + echo ' '"$CC $code \$(CFLAGS) -c -o $obj" + echo +done + +# Go over MIG definitions, generate header and source +# files for them, and build those source files. +if [ "$(uname)" = Darwin ]; then + mig_headers=$(echo "$root"/Sources/Protocol/*.h) + headers="$headers $mig_headers" + for defs in $(ls "$root/Sources/Protocol" | grep -F .defs); do + header="Protocol/${defs%.defs}.h" + code="Protocol/${defs%.defs}.c" + obj="Protocol/${defs%.defs}.o" + headers="$headers $header" + objs="$objs $obj" + generated="$generated $header $code" + echo "$header: $root/Sources/Protocol/$defs" + echo ' '"mig -sheader $header -server /dev/null -header /dev/null -user /dev/null $root/Sources/Protocol/$defs" + echo + echo "$code: $root/Sources/Protocol/$defs" + echo ' '"mig -server $code -header /dev/null -user /dev/null $root/Sources/Protocol/$defs" + echo + echo "$obj: $code $mig_headers" + echo ' '"$CC $code \$(CFLAGS) -I $root/Sources/Protocol -c -o $obj" + echo + done +fi + +# Collect the include directories and headers. Also create the +# corresponding directories right now, at configure time. +for dir in "" $dirs; do + if [ "$dir" = Mach ] && [ "$(uname)" != Darwin ]; then + continue + fi + includes="$includes -I $root/Sources/$dir" + headers=$(echo "$headers" "$root/Sources/$dir"/*.h) + if [ ! -z $dir ]; then + mkdir -p $dir + fi +done + +echo "INCLUDES = $includes" +echo "HEADERS = $headers" +echo +echo "CFLAGS = $CFLAGS" +echo "LDFLAGS = $LDFLAGS $LIBS" +echo + + +for dir in $dirs; do + # Skip Mach/ unless running on Darwin. + if [ "$dir" = Mach ] && [ "$(uname)" != Darwin ]; then + continue + fi + for file in $(ls "$root/Sources/$dir" | grep -F .m); do + obj=${file%.m}.o + objs="$objs $dir/$obj" + echo "$dir/$obj: $root/Sources/$dir/$file \$(HEADERS)" + echo ' '"$CC $root/Sources/$dir/$file \$(INCLUDES) \$(CFLAGS) -c -o $dir/$obj" + echo + done +done + +echo "OBJS = $objs" + +if [ "$(uname)" != Darwin ]; then + contents_dir="" +else + contents_dir="/Contents" +fi + +mkdir -p Owl.app$contents_dir/Resources/English.lproj + +for res in keymap.xkb Owl.icns; do + resources="$resources Owl.app$contents_dir/Resources/$res" + echo "Owl.app$contents_dir/Resources/$res: $root/Resources/$res" + echo ' '"cp $root/Resources/$res Owl.app$contents_dir/Resources/$res" + echo +done + +if [ "$(uname)" != Darwin ]; then + # Just copy the xibs over + for xib in $(ls "$root/Resources/English.lproj" | grep -F .xib); do + resources="$resources Owl.app/Resources/English.lproj/$xib" + echo "Owl.app/Resources/English.lproj/$xib: $root/Resources/English.lproj/$xib" + echo ' '"cp $root/Resources/English.lproj/$xib Owl.app/Resources/English.lproj/$xib" + echo + done +else + for xib in $(ls "$root/Resources/English.lproj" | grep -F .xib); do + nib="${xib%.xib}.nib" + resources="$resources Owl.app$contents_dir/Resources/English.lproj/$nib" + echo "Owl.app$contents_dir/Resources/English.lproj/$nib: $root/Resources/English.lproj/$xib" + echo ' '"ibtool --compile Owl.app$contents_dir/Resources/English.lproj/$nib $root/Resources/English.lproj/$xib" + echo + done +fi + +if [ "$(uname)" != Darwin ]; then + resources="$resources Owl.app/Resources/Info-gnustep.plist" + echo "Owl.app/Resources/Info-gnustep.plist: $root/Resources/Owl-Info-gnustep.plist" + echo ' '"cp $root/Resources/Owl-Info-gnustep.plist Owl.app/Resources/Info-gnustep.plist" + echo +else + resources="$resources Owl.app$contents_dir/Info.plist" + echo "Owl.app$contents_dir/Info.plist: $root/Resources/Owl-Info.plist" + echo ' '"cp $root/Resources/Owl-Info.plist Owl.app$contents_dir/Info.plist" + echo +fi + +if [ "$(uname)" != Darwin ]; then + platform_dir="" +else + case "$(sw_vers -productName)" in + "Mac OS X" | macOS) + platform_dir="/MacOS" + ;; + *) + echo "Don't know where to put the executable on this platform" >&2 + exit 1 + ;; + esac +fi + +mkdir -p "Owl.app$contents_dir$platform_dir" + +echo "Owl.app$contents_dir$platform_dir/Owl: \$(OBJS)" +echo ' '"$CC \$(OBJS) \$(LDFLAGS) -o Owl.app$contents_dir$platform_dir/Owl" +echo +echo "app: Owl.app$contents_dir$platform_dir/Owl $resources" +echo + +echo ".PHONY: clean all app" +echo "clean:" +echo ' '"rm -f \$(OBJS) $generated $resources" |