commit 10a7fe8d65e8f0ce9c1fc24ba6080afedcc1a76a Author: Chris Feng Date: Fri Jul 17 19:16:08 2015 +0800 First commit diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README b/README new file mode 100644 index 0000000..a0340f3 --- /dev/null +++ b/README @@ -0,0 +1,12 @@ +Emacs X Window Manager +====================== + +EXWM (Emacs X Window Manager) turns Emacs into a full-featured tiling X window +manager. Please refer to "exwm.el" for more details. + +EXWM is built on top of XELB and its utility libraris: + + XELB: https://github.com/ch11ng/xelb + + XELB utilility libraries: https://github.com/ch11ng/xelb-util + +You may also be intrested in an input method server designed for EXWM: + + EXIM: https://github.com/ch11ng/exim diff --git a/exwm-floating.el b/exwm-floating.el new file mode 100644 index 0000000..9e57c5c --- /dev/null +++ b/exwm-floating.el @@ -0,0 +1,431 @@ +;;; exwm-floating.el --- Floating Module for EXWM -*- lexical-binding: t -*- + +;; Copyright (C) 2015 Chris Feng + +;; Author: Chris Feng +;; Keywords: unix + +;; This file is not part of GNU Emacs. + +;; This file 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 file 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 file. If not, see . + +;;; Commentary: + +;; This module deals with the conversion between floating and non-floating +;; states and implements moving/resizing operations on floating windows. + +;; Todo: +;; + move/resize with keyboard. + +;;; Code: + +(require 'xcb-cursor) + +(defvar exwm-floating-border-width 1 "Border width of the floating window.") +(defvar exwm-floating-border-color "blue" + "Border color of the floating window.") + +(defun exwm-floating--set-floating (id) + "Make window ID floating." + (interactive) + (setq exwm-input--focus-lock t) + (when (get-buffer-window (exwm--id->buffer id)) ;window in non-floating state + (set-window-buffer (selected-window) (other-buffer))) ;hide it first + (let* ((original-frame + (with-current-buffer (exwm--id->buffer id) + (if (and exwm-transient-for (exwm--id->buffer exwm-transient-for)) + ;; Place a modal in the same workspace with its leading window + (with-current-buffer (exwm--id->buffer exwm-transient-for) + exwm--frame) + ;; Fallback to current workspace + exwm-workspace--current))) + (original-id (frame-parameter original-frame 'exwm-window-id)) + ;; Create new frame + (frame (with-current-buffer "*scratch*" + (make-frame `((minibuffer . nil) ;use the one on workspace + (background-color + . ,exwm-floating-border-color) + (internal-border-width + . ,exwm-floating-border-width) + (unsplittable . t))))) ;and fix the size later + (frame-id (string-to-int (frame-parameter frame 'window-id))) + (outer-id (string-to-int (frame-parameter frame 'outer-window-id))) + (window (frame-first-window frame)) ;and it's the only window + (x (slot-value exwm--geometry 'x)) + (y (slot-value exwm--geometry 'y)) + (width (slot-value exwm--geometry 'width)) + (height (slot-value exwm--geometry 'height))) + ;; Save window IDs + (set-frame-parameter frame 'exwm-window-id frame-id) + (set-frame-parameter frame 'exwm-outer-id outer-id) + ;; Set urgency flag if it's not appear in the active workspace + (let ((idx (cl-position original-frame exwm-workspace--list))) + (when (/= idx exwm-workspace-current-index) + (set-frame-parameter original-frame 'exwm--urgency t) + (exwm-workspace--update-switch-history))) + ;; Fix illegal parameters + ;; FIXME: check normal hints restrictions + (let* ((display-width (x-display-pixel-width)) + (display-height (- (x-display-pixel-height) + (window-pixel-height (minibuffer-window + original-frame)) + (* 2 (window-mode-line-height)) + (window-header-line-height window) + (* 2 exwm-floating-border-width))) + (display-height (* 2 (/ display-height 2)))) ;round to even + (if (> width display-width) + ;; Too wide + (progn (setq x 0 + width display-width)) + ;; Invalid width + (when (= 0 width) (setq width (/ display-width 2))) + ;; Completely outsize + (when (or (> x display-width) (> 0 (+ x display-width))) + (setq x (/ (- display-width width) 2)))) + (if (> height display-height) + ;; Too tall + (setq y 0 + height display-height) + ;; Invalid height + (when (= 0 height) (setq height (/ display-height 2))) + ;; Completely outside + (when (or (> y display-height) (> 0 (+ y display-height))) + (setq y (/ (- display-height height) 2))))) + ;; Set OverrideRedirect on this frame + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window outer-id :value-mask xcb:CW:OverrideRedirect + :override-redirect 1)) + ;; Set event mask + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window frame-id :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:SubstructureRedirect)) + ;; Reparent this frame to the original one + (xcb:+request exwm--connection + (make-instance 'xcb:ReparentWindow + :window outer-id :parent original-id + :x (- x exwm-floating-border-width) + :y (- y exwm-floating-border-width))) + ;; Save the geometry + ;; Rationale: the frame will not be ready for some time, thus we cannot + ;; infer the correct window size from its geometry. + (with-current-buffer (exwm--id->buffer id) + (setq exwm--floating-edges + (vector exwm-floating-border-width exwm-floating-border-width + (+ width exwm-floating-border-width) + (+ height exwm-floating-border-width)))) + ;; Fit frame to client + (xcb:+request exwm--connection + (make-instance 'xcb:ConfigureWindow + :window outer-id + :value-mask (logior xcb:ConfigWindow:Width + xcb:ConfigWindow:Height + xcb:ConfigWindow:StackMode) + :width (+ width (* 2 exwm-floating-border-width)) + :height (+ height (* 2 exwm-floating-border-width) + (window-mode-line-height) + (window-header-line-height)) + :stack-mode xcb:StackMode:Above)) ;top-most + ;; Reparent window to this frame + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:NoEvent)) + (xcb:+request exwm--connection + (make-instance 'xcb:ReparentWindow + :window id :parent frame-id + :x exwm-floating-border-width + :y exwm-floating-border-width)) + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask exwm--client-event-mask)) + (xcb:flush exwm--connection) + ;; Set window/buffer + (with-current-buffer (exwm--id->buffer id) + (setq window-size-fixed t ;make frame fixed size + exwm--frame original-frame + exwm--floating-frame frame) + (set-window-buffer window (current-buffer)) ;this changes current buffer + (set-window-dedicated-p window t)) + (with-current-buffer (exwm--id->buffer id) + ;; Some window should not get input focus on creation + ;; FIXME: other conditions? + (unless (memq xcb:Atom:_NET_WM_WINDOW_TYPE_UTILITY exwm-window-type) + (x-focus-frame exwm--floating-frame) + (exwm-input--set-focus id))) + (setq exwm-input--focus-lock nil))) + +(defun exwm-floating--unset-floating (id) + "Make window ID non-floating." + (interactive) + (setq exwm-input--focus-lock t) + (let ((buffer (exwm--id->buffer id))) + ;; Reparent to workspace frame + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:NoEvent)) + (xcb:+request exwm--connection + (make-instance 'xcb:ReparentWindow + :window id + :parent (frame-parameter exwm-workspace--current + 'exwm-window-id) + :x 0 :y 0)) ;temporary position + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask exwm--client-event-mask)) + (xcb:flush exwm--connection) + (with-current-buffer buffer + (when exwm--floating-frame ;from floating to non-floating + (setq exwm--floating-edges nil) ;invalid by now + (set-window-dedicated-p (frame-first-window exwm--floating-frame) nil) + (delete-frame exwm--floating-frame))) ;remove the floating frame + (with-current-buffer buffer + (setq exwm--floating-frame nil + exwm--frame exwm-workspace--current)) + (select-frame exwm-workspace--current t) + (set-window-buffer nil buffer) + (exwm-layout--show id) + (exwm-input--set-focus id)) + (setq exwm-input--focus-lock nil)) + +(defun exwm-floating-toggle-floating () + "Toggle the current window between floating and non-floating states." + (interactive) + (with-current-buffer (window-buffer) + (if exwm--floating-frame + (exwm-floating--unset-floating exwm--id) + (exwm-floating--set-floating exwm--id)))) + +(defvar exwm-floating--moveresize-id nil) +(defvar exwm-floating--moveresize-type nil) +(defvar exwm-floating--moveresize-delta nil) + +(defun exwm-floating--start-moveresize (id &optional type) + "Start move/resize." + (let ((buffer (exwm--id->buffer id)) + frame frame-id cursor) + (when (and buffer + (setq frame (with-current-buffer buffer exwm--floating-frame)) + (setq frame-id (frame-parameter frame 'exwm-outer-id)) + ;; Test if the pointer can be grabbed + (= xcb:GrabStatus:Success + (slot-value + (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:GrabPointer + :owner-events 0 :grab-window frame-id + :event-mask xcb:EventMask:NoEvent + :pointer-mode xcb:GrabMode:Async + :keyboard-mode xcb:GrabMode:Async + :confine-to xcb:Window:None + :cursor xcb:Cursor:None + :time xcb:Time:CurrentTime)) + 'status))) + (setq exwm--floating-edges nil) ;invalid by now + (with-slots (root-x root-y win-x win-y) + (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:QueryPointer :window id)) + (select-frame-set-input-focus frame) ;raise and focus it + (setq width (frame-pixel-width frame) + height (frame-pixel-height frame)) + (unless type + ;; Determine the resize type according to the pointer position + ;; Clicking the center 1/3 part to resize has not effect + (setq x (/ (* 3 win-x) (float width)) + y (/ (* 3 win-y) (float height)) + type (cond ((and (< x 1) (< y 1)) + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_TOPLEFT) + ((and (> x 2) (< y 1)) + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_TOPRIGHT) + ((and (> x 2) (> y 2)) + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT) + ((and (< x 1) (> y 2)) + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT) + ((< y 1) xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_TOP) + ((> x 2) xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_RIGHT) + ((> y 2) xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_BOTTOM) + ((< x 1) xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_LEFT)))) + (when type + (cond ((= type xcb:ewmh:_NET_WM_MOVERESIZE_MOVE) + (setq exwm-floating--moveresize-delta (list win-x win-y 0 0) + cursor exwm-floating--cursor-move)) + ((= type xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_TOPLEFT) + (setq exwm-floating--moveresize-delta + (list win-x win-y (+ root-x width) (+ root-y height)) + cursor exwm-floating--cursor-top-left)) + ((= type xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_TOP) + (setq exwm-floating--moveresize-delta + (list 0 win-y 0 (+ root-y height)) + cursor exwm-floating--cursor-top)) + ((= type xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_TOPRIGHT) + (setq exwm-floating--moveresize-delta + (list 0 win-y (- root-x width) (+ root-y height)) + cursor exwm-floating--cursor-top-right)) + ((= type xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_RIGHT) + (setq exwm-floating--moveresize-delta + (list 0 0 (- root-x width) 0) + cursor exwm-floating--cursor-right)) + ((= type xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT) + (setq exwm-floating--moveresize-delta + (list 0 0 (- root-x width) (- root-y height)) + cursor exwm-floating--cursor-bottom-right)) + ((= type xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_BOTTOM) + (setq exwm-floating--moveresize-delta + (list 0 0 0 (- root-y height)) + cursor exwm-floating--cursor-bottom)) + ((= type xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT) + (setq exwm-floating--moveresize-delta + (list win-x 0 (+ root-x width) (- root-y height)) + cursor exwm-floating--cursor-bottom-left)) + ((= type xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_LEFT) + (setq exwm-floating--moveresize-delta + (list win-x 0 (+ root-x width) 0) + cursor exwm-floating--cursor-left))) + ;; Select events and change cursor (should always succeed) + (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:GrabPointer + :owner-events 0 :grab-window frame-id + :event-mask (logior xcb:EventMask:ButtonRelease + xcb:EventMask:ButtonMotion) + :pointer-mode xcb:GrabMode:Async + :keyboard-mode xcb:GrabMode:Async + :confine-to xcb:Window:None + :cursor cursor + :time xcb:Time:CurrentTime)) + (setq exwm-floating--moveresize-id frame-id + exwm-floating--moveresize-type type)))))) + +(defun exwm-floating--stop-moveresize (&rest args) + "Stop move/resize." + (xcb:+request exwm--connection + (make-instance 'xcb:UngrabPointer :time xcb:Time:CurrentTime)) + (xcb:flush exwm--connection) + (setq exwm-floating--moveresize-id nil + exwm-floating--moveresize-type nil + exwm-floating--moveresize-delta nil)) + +(defun exwm-floating--do-moveresize (data synthetic) + "Perform move/resize." + (let ((mask 0) (x 0) (y 0) (width 0) (height 0) + (delta exwm-floating--moveresize-delta) + obj root-x root-y) + (when (and exwm-floating--moveresize-id exwm-floating--moveresize-type) + (setq obj (make-instance 'xcb:MotionNotify)) + (xcb:unmarshal obj data) + (setq root-x (slot-value obj 'root-x) + root-y (slot-value obj 'root-y)) + ;; Perform move/resize according to the previously set type + (cond ((= exwm-floating--moveresize-type + xcb:ewmh:_NET_WM_MOVERESIZE_MOVE) + (setq mask (logior xcb:ConfigWindow:X xcb:ConfigWindow:Y) + x (- root-x (elt delta 0)) + y (- root-y (elt delta 1)))) + ((= exwm-floating--moveresize-type + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_TOPLEFT) + (setq mask + (logior xcb:ConfigWindow:X xcb:ConfigWindow:Y + xcb:ConfigWindow:Width xcb:ConfigWindow:Height) + x (- root-x (elt delta 0)) + y (- root-y (elt delta 1)) + width (- (elt delta 2) root-x) + height (- (elt delta 3) root-y))) + ((= exwm-floating--moveresize-type + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_TOP) + (setq mask (logior xcb:ConfigWindow:Y xcb:ConfigWindow:Height) + y (- root-y (elt delta 1)) + height (- (elt delta 3) root-y))) + ((= exwm-floating--moveresize-type + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_TOPRIGHT) + (setq mask + (logior xcb:ConfigWindow:Y + xcb:ConfigWindow:Width xcb:ConfigWindow:Height) + y (- root-y (elt delta 1)) + width (- root-x (elt delta 2)) + height (- (elt delta 3) root-y))) + ((= exwm-floating--moveresize-type + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_RIGHT) + (setq mask (logior xcb:ConfigWindow:Width) + width (- root-x (elt delta 2)))) + ((= exwm-floating--moveresize-type + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT) + (setq mask + (logior xcb:ConfigWindow:Width xcb:ConfigWindow:Height) + width (- root-x (elt delta 2)) + height (- root-y (elt delta 3)))) + ((= exwm-floating--moveresize-type + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_BOTTOM) + (setq mask (logior xcb:ConfigWindow:Height) + height (- root-y (elt delta 3)))) + ((= exwm-floating--moveresize-type + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT) + (setq mask + (logior xcb:ConfigWindow:X + xcb:ConfigWindow:Width xcb:ConfigWindow:Height) + x (- root-x (elt delta 0)) + width (- (elt delta 2) root-x) + height (- root-y (elt delta 3)))) + ((= exwm-floating--moveresize-type + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_LEFT) + (setq mask + (logior xcb:ConfigWindow:X xcb:ConfigWindow:Width) + x (- root-x (elt delta 0)) + width (- (elt delta 2) root-x)))) + (xcb:+request exwm--connection + (make-instance 'xcb:ConfigureWindow + :window exwm-floating--moveresize-id :value-mask mask + :x x :y y :width width :height height)) + (xcb:flush exwm--connection)))) + +;; Cursors for moving/resizing a window +(defvar exwm-floating--cursor-move nil) +(defvar exwm-floating--cursor-top-left nil) +(defvar exwm-floating--cursor-top nil) +(defvar exwm-floating--cursor-top-right nil) +(defvar exwm-floating--cursor-right nil) +(defvar exwm-floating--cursor-bottom-right nil) +(defvar exwm-floating--cursor-bottom nil) +(defvar exwm-floating--cursor-bottom-left nil) +(defvar exwm-floating--cursor-left nil) + +(defun exwm-floating--init () + "Initialize floating module." + ;; Initialize cursors for moving/resizing a window + (xcb:cursor:init exwm--connection) + (setq exwm-floating--cursor-move + (xcb:cursor:load-cursor exwm--connection "fleur") + exwm-floating--cursor-top-left + (xcb:cursor:load-cursor exwm--connection "top_left_corner") + exwm-floating--cursor-top + (xcb:cursor:load-cursor exwm--connection "top_side") + exwm-floating--cursor-top-right + (xcb:cursor:load-cursor exwm--connection "top_right_corner") + exwm-floating--cursor-right + (xcb:cursor:load-cursor exwm--connection "right_side") + exwm-floating--cursor-bottom-right + (xcb:cursor:load-cursor exwm--connection "bottom_right_corner") + exwm-floating--cursor-bottom + (xcb:cursor:load-cursor exwm--connection "bottom_side") + exwm-floating--cursor-bottom-left + (xcb:cursor:load-cursor exwm--connection "bottom_left_corner") + exwm-floating--cursor-left + (xcb:cursor:load-cursor exwm--connection "left_side"))) + + + +(provide 'exwm-floating) + +;;; exwm-floating.el ends here diff --git a/exwm-input.el b/exwm-input.el new file mode 100644 index 0000000..107df05 --- /dev/null +++ b/exwm-input.el @@ -0,0 +1,451 @@ +;;; exwm-input.el --- Input Module for EXWM -*- lexical-binding: t -*- + +;; Copyright (C) 2015 Chris Feng + +;; Author: Chris Feng +;; Keywords: unix + +;; This file is not part of GNU Emacs. + +;; This file 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 file 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 file. If not, see . + +;;; Commentary: + +;; This module deals with key/mouse matters, including: +;; + Input focus, +;; + Key/Button event handling, +;; + Key events filtering and simulation. + +;; Todo: +;; + Pointer simulation mode (e.g. 'C-c 1'/'C-c 2' for single/double click, +;; move with arrow keys). +;; + Demonstrate how to add a local key binding (add global prefix key and +;; modify `exwm-mode-map'). +;; + Simulation keys to mimic Emacs key bindings for text edit (redo, select, +;; cancel, clear, etc). Some of them are not present on common keyboard +;; (keycode = 0). May need to use XKB extension. + +;;; Code: + +(require 'xcb-keysyms) +(require 'exwm-floating) + +(defvar exwm-input-move-event 's-down-mouse-1 + "Emacs event to start moving a window.") +(defvar exwm-input-resize-event 's-down-mouse-3 + "Emacs event to start resizing a window.") + +(defvar exwm-input--move-keysym nil) +(defvar exwm-input--move-mask nil) +(defvar exwm-input--resize-keysym nil) +(defvar exwm-input--resize-mask nil) + +(defvar exwm-input--timestamp xcb:Time:CurrentTime + "A recent timestamp received from X server. + +It's updated in several occasions, and only used by `exwm-input--set-focus'.") + +(defun exwm-input--set-focus (id) + "Set input focus to window ID in a proper way." + (exwm--with-current-id id + (setq exwm-input--focus-id id) + (if (and (not exwm--hints-input) + (memq xcb:Atom:WM_TAKE_FOCUS exwm--protocols)) + (xcb:+request exwm--connection + (make-instance 'xcb:icccm:SendEvent + :destination id + :event (xcb:marshal + (make-instance 'xcb:icccm:WM_TAKE_FOCUS + :window id + :time exwm-input--timestamp) + exwm--connection))) + (xcb:+request exwm--connection + (make-instance 'xcb:SetInputFocus + :revert-to xcb:InputFocus:Parent :focus id + :time xcb:Time:CurrentTime))) + (xcb:flush exwm--connection))) + +(defvar exwm-input--focus-id xcb:Window:None + "The window that is theoretically focused.") +(defvar exwm-input--focus-lock nil + "Non-nil when input focus should stay unchanged.") + +(defun exwm-input--update-focus () + "Update input focus." + (unless exwm-input--focus-lock + (setq exwm-input--focus-lock t) + (when (eq (current-buffer) (window-buffer)) ;e.g. with-temp-buffer + (if (eq major-mode 'exwm-mode) + (progn (setq exwm-input--focus-id exwm--id) + (when exwm--floating-frame + (if (eq (selected-frame) exwm--floating-frame) + ;; Cancel the possible input focus redirection + (redirect-frame-focus exwm--floating-frame nil) + ;; Focus the floating frame + (x-focus-frame exwm--floating-frame))) + ;; Finally focus the window + (exwm-input--set-focus exwm-input--focus-id)) + (exwm--with-current-id exwm-input--focus-id + (setq exwm-input--focus-id xcb:Window:None) + (let ((frame (selected-frame))) + (if exwm--floating-frame + (unless (or (eq frame exwm--floating-frame) + (active-minibuffer-window)) + ;; Redirect input focus to the workspace frame + (redirect-frame-focus exwm--floating-frame frame)) + ;; Focus the workspace frame + (x-focus-frame frame)))))) + (setq exwm-input--focus-lock nil))) + +(defun exwm-input--finish-key-sequence () + "Mark the end of a key sequence (with the aid of `pre-command-hook')." + (setq exwm-input--during-key-sequence nil) + (when exwm-input--temp-line-mode + (setq exwm-input--temp-line-mode nil) + (exwm-input--release-keyboard))) + +(defun exwm-input--on-MappingNotify (data synthetic) + "Handle MappingNotify event." + (let ((obj (make-instance 'xcb:MappingNotify))) + (xcb:unmarshal obj data) + (with-slots (request first-keycode count) obj + (cond ((= request xcb:Mapping:Modifier) + ;; Modifier keys changed + (xcb:keysyms:update-modifier-mapping exwm--connection)) + ((= request xcb:Mapping:Keyboard) + ;; Only updated changed keys + (xcb:keysyms:update-keyboard-mapping exwm--connection + first-keycode count)))))) + +(defun exwm-input--on-ButtonPress (data synthetic) + "Handle ButtonPress event." + (let ((obj (make-instance 'xcb:ButtonPress)) + (mode xcb:Allow:SyncPointer)) + (xcb:unmarshal obj data) + (with-slots (detail time event state) obj + (setq exwm-input--timestamp time) + (cond ((and (= state exwm-input--move-mask) + (= detail exwm-input--move-keysym)) + ;; Move + (exwm-floating--start-moveresize event + xcb:ewmh:_NET_WM_MOVERESIZE_MOVE)) + ((and (= state exwm-input--resize-mask) + (= detail exwm-input--resize-keysym)) + ;; Resize + (exwm-floating--start-moveresize event)) + (t + ;; Click to focus + (unless (and (boundp 'exwm--id) (= event exwm--id)) + (exwm--with-current-id event + (raise-frame (or exwm--floating-frame exwm--frame)) + (select-window (get-buffer-window nil 'visible)))) + ;; The event should be replayed + (setq mode xcb:Allow:ReplayPointer)))) + (xcb:+request exwm--connection + (make-instance 'xcb:AllowEvents :mode mode :time xcb:Time:CurrentTime)) + (xcb:flush exwm--connection))) + +(defun exwm-input--on-KeyPress (data synthetic) + "Handle KeyPress event." + (let ((obj (make-instance 'xcb:KeyPress))) + (xcb:unmarshal obj data) + (setq exwm-input--timestamp (slot-value obj 'time)) + (funcall 'exwm-input--handle-KeyPress obj))) + +(defvar exwm-input--global-keys nil "Global key bindings.") +(defvar exwm-input--global-prefix-keys nil + "List of prefix keys of global key bindings.") + +(defun exwm-input--update-global-prefix-keys () + "Update `exwm-input--global-prefix-keys'." + (when exwm--connection + (let ((original exwm-input--global-prefix-keys) + keysym) + (setq exwm-input--global-prefix-keys nil) + (dolist (i exwm-input--global-keys) + (cl-pushnew (elt i 0) exwm-input--global-prefix-keys)) + (unless (equal original exwm-input--global-prefix-keys) + ;; Grab global keys on root window + (if (xcb:+request-checked+request-check exwm--connection + (make-instance 'xcb:UngrabKey + :key xcb:Grab:Any :grab-window exwm--root + :modifiers xcb:ModMask:Any)) + (exwm--log "Failed to ungrab keys") + (dolist (i exwm-input--global-prefix-keys) + (setq keysym (xcb:keysyms:event->keysym i)) + (when (or (not keysym) + (xcb:+request-checked+request-check exwm--connection + (make-instance 'xcb:GrabKey + :owner-events 0 + :grab-window exwm--root + :modifiers (cadr keysym) + :key (xcb:keysyms:keysym->keycode + exwm--connection (car keysym)) + :pointer-mode xcb:GrabMode:Async + :keyboard-mode xcb:GrabMode:Async))) + (user-error "[EXWM] Failed to grab key: %s" i)))))))) + +(defun exwm-input-set-key (key command) + "Set a global key binding." + (global-set-key key command) + (cl-pushnew key exwm-input--global-keys)) + +(defvar exwm-input--during-key-sequence nil + "Non-nil indicates Emacs is waiting for more keys to form a key sequence.") +(defvar exwm-input--temp-line-mode nil + "Non-nil indicates it's in temporary line-mode for char-mode.") + +;; ;; This implementation has a problem that it also releases queued keys after +;; ;; requesting AllowEvent. The client window will capture unexpected key events +;; ;; in this case. +;; ;; P.S.; to use this implementation, comment out the KeyRelease listener +;; ;; together with this one and make GrabKey in Sync mode. +;; (cl-defmethod exwm-input--handle-KeyPress-line-mode ((obj xcb:KeyPress)) +;; "Parse X KeyPress event to Emacs key event and then feed the command loop." +;; (with-slots (detail state) obj +;; (let ((keysym (xcb:keysyms:keycode->keysym exwm--connection detail state)) +;; event window mode) +;; (when (and keysym +;; (setq event (xcb:keysyms:keysym->event keysym state)) +;; (or exwm-input--during-key-sequence +;; (= exwm-input--focus-id xcb:Window:None) +;; (setq window (active-minibuffer-window)) +;; (eq event ?\C-c) ;mode-specific key +;; (memq event exwm-input--global-prefix-keys) +;; (memq event exwm-input-prefix-keys) +;; (memq event +;; exwm-input--simulation-prefix-keys))) +;; (setq mode xcb:Allow:SyncKeyboard) +;; (unless window (setq exwm-input--during-key-sequence t)) +;; (push event unread-command-events)) +;; (xcb:+request exwm--connection +;; (make-instance 'xcb:AllowEvents +;; :mode (or mode xcb:Allow:ReplayKeyboard) +;; :time xcb:Time:CurrentTime)) +;; (xcb:flush exwm--connection)))) + +;; This implementation has a drawback that some (legacy) applications +;; (e.g. xterm) ignore the synthetic key events, making it only viable for EXWM +;; to work in char-mode in such case. +(cl-defmethod exwm-input--handle-KeyPress-line-mode ((obj xcb:KeyPress)) + "Parse X KeyPress event to Emacs key event and then feed the command loop." + (with-slots (detail state) obj + (let ((keysym (xcb:keysyms:keycode->keysym exwm--connection detail state)) + event minibuffer-window) + (if (and keysym + (setq event (xcb:keysyms:keysym->event keysym state)) + (or exwm-input--during-key-sequence + (= exwm-input--focus-id xcb:Window:None) + (setq minibuffer-window (active-minibuffer-window)) + (eq event ?\C-c) ;mode-specific key + (memq event exwm-input--global-prefix-keys) + (memq event exwm-input-prefix-keys) + (memq event exwm-input--simulation-prefix-keys))) + ;; Forward key to Emacs frame + (progn (unless minibuffer-window + (setq exwm-input--during-key-sequence t)) + (push event unread-command-events)) + ;; Forward key to window + (xcb:+request exwm--connection + (make-instance 'xcb:SendEvent + :propagate 0 :destination (slot-value obj 'event) + :event-mask xcb:EventMask:NoEvent + :event (xcb:marshal obj exwm--connection))) + (xcb:flush exwm--connection))))) + +(cl-defmethod exwm-input--handle-KeyPress-char-mode ((obj xcb:KeyPress)) + "Handle KeyPress event in char-mode." + (with-slots (detail state) obj + (let ((keysym (xcb:keysyms:keycode->keysym exwm--connection detail state)) + event) + (when (and keysym (setq event (xcb:keysyms:keysym->event keysym state))) + (setq exwm-input--temp-line-mode t + exwm-input--during-key-sequence t) + (push event unread-command-events) + (exwm-input--grab-keyboard))))) ;grab keyboard temporarily + +(defalias 'exwm-input--handle-KeyPress 'exwm-input--handle-KeyPress-line-mode + "Generic function for handling KeyPress event.") + +(defun exwm-input--grab-keyboard (&optional id) + "Grab all key events on window ID." + (unless id (setq id (exwm--buffer->id (window-buffer)))) + (when (xcb:+request-checked+request-check exwm--connection + (make-instance 'xcb:GrabKey + :owner-events 0 :grab-window id + :modifiers xcb:ModMask:Any + :key xcb:Grab:Any + :pointer-mode xcb:GrabMode:Async + :keyboard-mode xcb:GrabMode:Async)) + (exwm--log "Failed to grab keyboard for #x%x" id)) + (defalias 'exwm-input--handle-KeyPress + 'exwm-input--handle-KeyPress-line-mode)) + +(defun exwm-input--release-keyboard (&optional id) + "Ungrab all key events on window ID." + (unless id (setq id (exwm--buffer->id (window-buffer)))) + (when (xcb:+request-checked+request-check exwm--connection + (make-instance 'xcb:UngrabKey + :key xcb:Grab:Any :grab-window id + :modifiers xcb:ModMask:Any)) + (exwm--log "Failed to release keyboard for #x%x" id)) + (defalias 'exwm-input--handle-KeyPress + 'exwm-input--handle-KeyPress-char-mode)) + +(defun exwm-input-grab-keyboard (&optional id) + "Switch to line-mode." + (interactive) + (exwm-input--grab-keyboard id) + (setq mode-line-process + '(": " + (:propertize "line" + help-echo "mouse-1: Switch to char-mode" + mouse-face mode-line-highlight + local-map + (keymap + (mode-line + keymap + (down-mouse-1 . exwm-input-release-keyboard)))))) + (force-mode-line-update)) + +(defun exwm-input-release-keyboard (&optional id) + "Switch to char-mode." + (interactive) + (exwm-input--release-keyboard id) + (setq mode-line-process + '(": " + (:propertize "char" + help-echo "mouse-1: Switch to line-mode" + mouse-face mode-line-highlight + local-map + (keymap + (mode-line + keymap + (down-mouse-1 . exwm-input-grab-keyboard)))))) + (force-mode-line-update)) + +(defun exwm-input--fake-key (event) + "Fake a key event equivalent to Emacs event EVENT." + (let* ((keysym (xcb:keysyms:event->keysym event)) + (keycode (xcb:keysyms:keysym->keycode exwm--connection (car keysym))) + (id (exwm--buffer->id (window-buffer (selected-window))))) + (when keycode + (xcb:+request exwm--connection + (make-instance 'xcb:SendEvent + :propagate 0 :destination id + :event-mask xcb:EventMask:NoEvent + :event (xcb:marshal + (make-instance 'xcb:KeyPress + :detail keycode + :time xcb:Time:CurrentTime + :root exwm--root :event id + :child 0 + :root-x 0 :root-y 0 + :event-x 0 :event-y 0 + :state (cadr keysym) + :same-screen 1) + exwm--connection)))) + (xcb:flush exwm--connection))) + +(defun exwm-input-send-next-key (times) + "Send next key to client window." + (interactive "p") + (when (> times 12) (setq times 12)) + (let (key keys) + (dotimes (i times) + ;; Skip events not from keyboard + (setq exwm-input--during-key-sequence t) + (catch 'break + (while t + (setq key (read-key (format "Send key: %s (%d/%d)" + (key-description keys) + (1+ i) times))) + (unless (listp key) (throw 'break nil)))) + (setq exwm-input--during-key-sequence nil) + (setq keys (vconcat keys (vector key))) + (exwm-input--fake-key key)))) + +;; (defun exwm-input-send-last-key () +;; (interactive) +;; (unless (listp last-input-event) ;not a key event +;; (exwm-input--fake-key last-input-event))) + +(defvar exwm-input-prefix-keys + '(?\C-x ?\C-u ?\C-h ?\M-x ?\M-` ?\M-\S-! ?\M-\S-& ?\M-\S-:) + "List of prefix keys EXWM should forward to Emacs when in line-mode.") + +(defvar exwm-input--simulation-keys nil "Simulation keys in line-mode.") +(defvar exwm-input--simulation-prefix-keys nil + "List of prefix keys of simulation keys in line-mode.") + +(defun exwm-input--update-simulation-prefix-keys () + "Update the list of prefix keys of simulation keys." + (setq exwm-input--simulation-prefix-keys nil) + (dolist (i exwm-input--simulation-keys) + (define-key exwm-mode-map (car i) 'exwm-input-send-simulation-key) + (cl-pushnew (elt (car i) 0) exwm-input--simulation-prefix-keys))) + +(defun exwm-input-set-simulation-keys (simulation-keys) + "Set simulation keys. + +SIMULATION-KEYS is a list of alist (key-sequence1 . key-sequence2)." + (setq exwm-input--simulation-keys nil) + (dolist (i simulation-keys) + (cl-pushnew `(,(vconcat (car i)) . ,(cdr i)) exwm-input--simulation-keys)) + (exwm-input--update-simulation-prefix-keys)) + +(defun exwm-input-send-simulation-key () + "Fake a key event according to last input key sequence." + (interactive) + (let ((pair (assoc (this-command-keys-vector) ;FIXME: pefix + exwm-input--simulation-keys)) + key) + (when pair + (setq pair (cdr pair)) + (unless (listp pair) + (setq pair (list pair))) + (dolist (i pair) + (exwm-input--fake-key i))))) + +(defun exwm-input--init () + "Initialize the keyboard module." + ;; Refresh keyboard mapping + (xcb:keysyms:init exwm--connection) + ;; Convert move/resize buttons + (let ((move-key (xcb:keysyms:event->keysym exwm-input-move-event)) + (resize-key (xcb:keysyms:event->keysym exwm-input-resize-event))) + (setq exwm-input--move-keysym (car move-key) + exwm-input--move-mask (cadr move-key) + exwm-input--resize-keysym (car resize-key) + exwm-input--resize-mask (cadr resize-key))) + ;; Attach event listeners + (xcb:+event exwm--connection 'xcb:MappingNotify + 'exwm-input--on-MappingNotify) + (xcb:+event exwm--connection 'xcb:KeyPress 'exwm-input--on-KeyPress) + (xcb:+event exwm--connection 'xcb:ButtonPress 'exwm-input--on-ButtonPress) + (xcb:+event exwm--connection 'xcb:ButtonRelease + 'exwm-floating--stop-moveresize) + (xcb:+event exwm--connection 'xcb:MotionNotify 'exwm-floating--do-moveresize) + ;; `pre-command-hook' marks the end of a key sequence (existing or not) + (add-hook 'pre-command-hook 'exwm-input--finish-key-sequence) + ;; Update focus when buffer list updates + (add-hook 'buffer-list-update-hook 'exwm-input--update-focus) + ;; Update prefix keys for global keys + (exwm-input--update-global-prefix-keys)) + + + +(provide 'exwm-input) + +;;; exwm-input.el ends here diff --git a/exwm-layout.el b/exwm-layout.el new file mode 100644 index 0000000..7630b68 --- /dev/null +++ b/exwm-layout.el @@ -0,0 +1,194 @@ +;;; exwm-layout.el --- Layout Module for EXWM -*- lexical-binding: t -*- + +;; Copyright (C) 2015 Chris Feng + +;; Author: Chris Feng +;; Keywords: unix + +;; This file is not part of GNU Emacs. + +;; This file 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 file 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 file. If not, see . + +;;; Commentary: + +;; This module is responsible for keeping X client window properly displayed. + +;;; Code: + +(defun exwm-layout--show (id &optional window) + "Show window ID exactly fit in the Emacs window WINDOW." + (xcb:+request exwm--connection (make-instance 'xcb:MapWindow :window id)) + (xcb:+request exwm--connection + (make-instance 'xcb:icccm:set-WM_STATE + :window id :state xcb:icccm:WM_STATE:NormalState + :icon xcb:Window:None)) + (let* ((edges (or (exwm--with-current-id id exwm--floating-edges) + (window-inside-pixel-edges window))) + (x (elt edges 0)) + (y (elt edges 1)) + (width (- (elt edges 2) (elt edges 0))) + (height (- (elt edges 3) (elt edges 1)))) + (xcb:+request exwm--connection + (make-instance 'xcb:ConfigureWindow + :window id + :value-mask (logior xcb:ConfigWindow:X + xcb:ConfigWindow:Y + xcb:ConfigWindow:Width + xcb:ConfigWindow:Height + xcb:ConfigWindow:StackMode) + :x x :y y :width width :height height + ;; In order to put non-floating window at bottom + :stack-mode xcb:StackMode:Below)) + (xcb:+request exwm--connection + (make-instance 'xcb:SendEvent + :propagate 0 :destination id + :event-mask xcb:EventMask:StructureNotify + :event (xcb:marshal + (make-instance 'xcb:ConfigureNotify + :event id :window id + :above-sibling xcb:Window:None + :x x :y y + :width width :height height + :border-width 0 + :override-redirect 0) + exwm--connection)))) + (xcb:flush exwm--connection)) + +(defun exwm-layout--hide (id) + "Hide window ID." + (unless (eq xcb:icccm:WM_STATE:IconicState ;already hidden + (with-current-buffer (exwm--id->buffer id) exwm-state)) + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:NoEvent)) + (xcb:+request exwm--connection (make-instance 'xcb:UnmapWindow :window id)) + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask exwm--client-event-mask)) + (xcb:+request exwm--connection + (make-instance 'xcb:icccm:set-WM_STATE + :window id + :state xcb:icccm:WM_STATE:IconicState + :icon xcb:Window:None)) + (xcb:flush exwm--connection))) + +(defun exwm-layout-set-fullscreen (&optional id) + "Make window ID fullscreen." + (interactive) + (with-current-buffer (if id (exwm--id->buffer id) (window-buffer)) + ;; Set the floating frame fullscreen first when the client is floating + (when exwm--floating-frame + (let* ((outer-id (frame-parameter exwm--floating-frame 'exwm-outer-id)) + (geometry (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:GetGeometry + :drawable outer-id)))) + (setq exwm--floating-frame-geometry + (vector (slot-value geometry 'x) (slot-value geometry 'y) + (slot-value geometry 'width) + (slot-value geometry 'height))) + (xcb:+request exwm--connection + (make-instance 'xcb:ConfigureWindow + :window outer-id + :value-mask (logior xcb:ConfigWindow:X + xcb:ConfigWindow:Y + xcb:ConfigWindow:Width + xcb:ConfigWindow:Height) + :x 0 :y 0 + :width (x-display-pixel-width) + :height (x-display-pixel-height)))) + (xcb:flush exwm--connection)) + (xcb:+request exwm--connection + (make-instance 'xcb:ConfigureWindow + :window exwm--id + :value-mask (logior xcb:ConfigWindow:X + xcb:ConfigWindow:Y + xcb:ConfigWindow:Width + xcb:ConfigWindow:Height) + :x 0 :y 0 + :width (x-display-pixel-width) + :height (x-display-pixel-height))) + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_WM_STATE + :window exwm--id + :data (vector xcb:Atom:_NET_WM_STATE_FULLSCREEN))) + (xcb:flush exwm--connection) + (cl-assert (not exwm--fullscreen)) + (setq exwm--fullscreen t) + (exwm-input-release-keyboard))) + +(defun exwm-layout-unset-fullscreen (&optional id) + "Restore window from fullscreen state." + (interactive) + (with-current-buffer (if id (exwm--id->buffer id) (window-buffer)) + ;; Restore the floating frame if the client is floating + (when exwm--floating-frame + (xcb:+request exwm--connection + (make-instance 'xcb:ConfigureWindow + :window (frame-parameter exwm--floating-frame + 'exwm-outer-id) + :value-mask (logior xcb:ConfigWindow:X + xcb:ConfigWindow:Y + xcb:ConfigWindow:Width + xcb:ConfigWindow:Height) + :x (elt exwm--floating-frame-geometry 0) + :y (elt exwm--floating-frame-geometry 1) + :width (elt exwm--floating-frame-geometry 2) + :height (elt exwm--floating-frame-geometry 3)))) + (exwm-layout--show exwm--id) + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_WM_STATE :window exwm--id :data [])) + (xcb:flush exwm--connection) + (cl-assert exwm--fullscreen) + (setq exwm--fullscreen nil) + (exwm-input-grab-keyboard))) + +(defvar exwm-layout--window-configuration (current-window-configuration) + "Last saved window configuration, for avoiding unnecessary refreshes.") + +(defun exwm-layout--refresh () + "Refresh layout." + (unless (compare-window-configurations exwm-layout--window-configuration + (current-window-configuration)) + (setq exwm-layout--window-configuration (current-window-configuration)) + (let ((frame (selected-frame)) + windows) + (if (not (memq frame exwm-workspace--list)) + ;; Refresh a floating frame + (when (eq major-mode 'exwm-mode) + (with-current-buffer (window-buffer (frame-first-window frame)) + (exwm-layout--show exwm--id (frame-first-window frame)))) + ;; Refresh the whole workspace + (dolist (pair exwm--id-buffer-alist) + (with-current-buffer (cdr pair) + ;; Exclude windows on other workspaces and floating frames + (when (and (eq frame exwm--frame) (not exwm--floating-frame)) + (setq windows (get-buffer-window-list (current-buffer) 0)) + (if (not windows) + (exwm-layout--hide exwm--id) + (exwm-layout--show exwm--id (car windows)) + (dolist (i (cdr windows)) + (set-window-buffer i "*scratch*")))))))))) + +(defun exwm-layout--init () + "Initialize layout module." + ;; Auto refresh layout + (add-hook 'window-configuration-change-hook 'exwm-layout--refresh)) + + + +(provide 'exwm-layout) + +;;; exwm-layout.el ends here diff --git a/exwm-manage.el b/exwm-manage.el new file mode 100644 index 0000000..afab18e --- /dev/null +++ b/exwm-manage.el @@ -0,0 +1,333 @@ +;;; exwm-manage.el --- Window Management Module for -*- lexical-binding: t -*- +;;; EXWM + +;; Copyright (C) 2015 Chris Feng + +;; Author: Chris Feng +;; Keywords: unix + +;; This file is not part of GNU Emacs. + +;; This file 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 file 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 file. If not, see . + +;;; Commentary: + +;; This is the fundamental module of EXWM that deals with window management. + +;;; Code: + +(require 'exwm-input) + +(defvar exwm-manage-finish-hook nil + "Normal hook run after a window is just managed, in the context of the +corresponding buffer.") + +(defun exwm-manage--update-geometry (id &optional force) + "Update window geometry." + (exwm--with-current-id id + (unless (and exwm--geometry (not force)) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:GetGeometry :drawable id)))) + (when reply ;nil when destroyed + (setq exwm--geometry reply)))))) + +(defun exwm-manage--manage-window (id) + "Manage window ID." + (setq exwm-input--focus-lock t) + (catch 'return + ;; Ensure it's not managed + (when (assoc id exwm--id-buffer-alist) + (throw 'return 'managed)) + ;; Ensure it's alive + (when (xcb:+request-checked+request-check exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask exwm--client-event-mask)) + (throw 'return 'dead)) + (with-current-buffer (generate-new-buffer "*EXWM*") + (push `(,id . ,(current-buffer)) exwm--id-buffer-alist) + (exwm-mode) + (setq exwm--id id) + (exwm--update-window-type id) + (exwm--update-class id) + (exwm-manage--update-geometry id) + ;; No need to manage (please check OverrideRedirect outside) + (when (or + (not + (or (not exwm-window-type) + (memq xcb:Atom:_NET_WM_WINDOW_TYPE_UTILITY exwm-window-type) + (memq xcb:Atom:_NET_WM_WINDOW_TYPE_DIALOG exwm-window-type) + (memq xcb:Atom:_NET_WM_WINDOW_TYPE_NORMAL exwm-window-type))) + ;; For Java applications + (and exwm-instance-name + (string-prefix-p "sun-awt-X11-" exwm-instance-name) + (not (string-suffix-p "XFramePeer" exwm-instance-name)))) + ;; Remove all events + (xcb:+request-checked+request-check exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:NoEvent)) + ;; The window needs to be mapped + (xcb:+request exwm--connection + (make-instance xcb:MapWindow :window id)) + (with-slots (x y width height) exwm--geometry + ;; Reparent to virtual root (essential) + (xcb:+request exwm--connection + (make-instance 'xcb:ReparentWindow + :window id + :parent (frame-parameter exwm-workspace--current + 'exwm-window-id) + :x x :y y)) + ;; Center window of type _NET_WM_WINDOW_TYPE_SPLASH + (when (memq xcb:Atom:_NET_WM_WINDOW_TYPE_SPLASH exwm-window-type) + (xcb:+request exwm--connection + (make-instance 'xcb:ConfigureWindow + :window id + :value-mask (logior xcb:ConfigWindow:X + xcb:ConfigWindow:Y) + :x (/ (- (x-display-pixel-width) width) 2) + :y (/ (- (x-display-pixel-height) height) 2))))) + (xcb:flush exwm--connection) + (setq kill-buffer-query-functions nil) + (setq exwm--id-buffer-alist (assq-delete-all id exwm--id-buffer-alist)) + (kill-buffer (current-buffer)) + (throw 'return 'ignored)) + ;; Manage the window + (xcb:+request exwm--connection ;remove border + (make-instance 'xcb:ConfigureWindow + :window id :value-mask xcb:ConfigWindow:BorderWidth + :border-width 0)) + (xcb:+request exwm--connection ;grab buttons for set focus/move/resize + (make-instance 'xcb:GrabButton + :owner-events 0 :grab-window id + :event-mask xcb:EventMask:ButtonPress + :pointer-mode xcb:GrabMode:Sync + :keyboard-mode xcb:GrabMode:Async + :confine-to xcb:Window:None + :cursor xcb:Cursor:None + :button xcb:ButtonIndex:Any + :modifiers xcb:ModMask:Any)) + (xcb:flush exwm--connection) + (exwm--update-title id) + (exwm--update-transient-for id) + (exwm--update-normal-hints id) + (exwm--update-hints id) + (exwm--update-protocols id) + (exwm--update-state id) + (if (or exwm-transient-for exwm--fixed-size + (memq xcb:Atom:_NET_WM_WINDOW_TYPE_UTILITY exwm-window-type) + (memq xcb:Atom:_NET_WM_WINDOW_TYPE_DIALOG exwm-window-type)) + (exwm-floating--set-floating id) + (exwm-floating--unset-floating id)) + (exwm-input-grab-keyboard id) + (exwm-workspace--update-switch-history) + (setq exwm-input--focus-lock nil) ;unlocked in advance + (with-current-buffer (exwm--id->buffer id) + (run-hooks 'exwm-manage-finish-hook)))) + (setq exwm-input--focus-lock nil)) + +(defun exwm-manage--unmanage-window (id &optional withdraw-only) + "Unmanage window ID." + (let ((buffer (exwm--id->buffer id))) + (setq exwm--id-buffer-alist (assq-delete-all id exwm--id-buffer-alist)) + (when (buffer-live-p buffer) + (with-current-buffer buffer + (exwm-workspace--update-switch-history) + ;; + (when withdraw-only + ;; Reparent back to root + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:NoEvent)) + (let (x y geometry geometry-parent) + (if (not exwm--floating-frame) + (setq x 0 y 0) ;the position does not matter + (setq geometry-parent + (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:GetGeometry + :drawable + (frame-parameter exwm--floating-frame + 'exwm-outer-id))) + geometry (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:GetGeometry + :drawable id))) + (if (not (and geometry-parent geometry)) + (setq x 0 y 0) ;e.g. have been destroyed + (setq x (+ (slot-value geometry-parent 'x) + (slot-value geometry 'x)) + y (+ (slot-value geometry-parent 'y) + (slot-value geometry 'y))))) + (xcb:+request exwm--connection + (make-instance 'xcb:ReparentWindow + :window id :parent exwm--root :x x :y y))) + ;; Delete WM_STATE property + (xcb:+request exwm--connection + (make-instance 'xcb:DeleteProperty + :window id :property xcb:Atom:WM_STATE)) + (xcb:flush exwm--connection)) + (setq kill-buffer-query-functions nil) + (kill-buffer) + (select-frame-set-input-focus exwm-workspace--current))))) + +(defun exwm-manage--scan () + "Search for existing windows and try to manage them." + (let* ((tree (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:QueryTree :window exwm--root)))) + (dolist (i (slot-value tree 'children)) + (with-slots (override-redirect map-state) + (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:GetWindowAttributes :window i)) + (when (and (= 0 override-redirect) (= xcb:MapState:Viewable map-state)) + (exwm-manage--manage-window i)))))) + +(defvar exwm-manage--ping-lock nil + "Non-nil indicates EXWM is pinging a window.") +(defvar exwm-manage-ping-timeout 3 "Seconds to wait before killing a client.") + +(defun exwm-manage--close-window (id &optional buffer) + "Close window ID in a proper way." + (catch 'return + (unless buffer (setq buffer (exwm--id->buffer id))) + ;; Destroy the client window if it does not support WM_DELETE_WINDOW + (unless (and (buffer-live-p buffer) + (with-current-buffer buffer + (memq xcb:Atom:WM_DELETE_WINDOW exwm--protocols))) + (xcb:+request exwm--connection + (make-instance 'xcb:DestroyWindow :window id)) + (xcb:flush exwm--connection) + (throw 'return nil)) + ;; Try to close the window with WM_DELETE_WINDOW client message + (xcb:+request exwm--connection + (make-instance 'xcb:icccm:SendEvent + :destination id + :event (xcb:marshal + (make-instance 'xcb:icccm:WM_DELETE_WINDOW + :window id) + exwm--connection))) + (xcb:flush exwm--connection) + ;; Try to determine if the client stop responding + ;; FIXME: check + (with-current-buffer buffer + (when (memq xcb:Atom:_NET_WM_PING exwm--protocols) + (setq exwm-manage--ping-lock t) + (xcb:+request exwm--connection + (make-instance 'xcb:SendEvent + :propagate 0 :destination id + :event-mask xcb:EventMask:NoEvent + :event (xcb:marshal + (make-instance 'xcb:ewmh:_NET_WM_PING + :window id :timestamp 0 + :client-window id) + exwm--connection))) + (xcb:flush exwm--connection) + (with-timeout (exwm-manage-ping-timeout + (if (yes-or-no-p (format "\ +`%s' is not responding. Would you like to kill it? " (buffer-name buffer))) + (progn (exwm-manage--kill-client id) + (throw 'return nil)) + (throw 'return nil))) + (while (and exwm-manage--ping-lock + (exwm--id->buffer id)) ;may have be destroyed + (accept-process-output nil 0.1))) + (throw 'return nil))) + (throw 'return nil))) + +(defun exwm-manage--kill-client (&optional id) + "Kill an X client." + (interactive) + (unless id (setq id (exwm--buffer->id (current-buffer)))) + (let ((pid (slot-value + (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:ewmh:get-_NET_WM_PID :window id)) + 'value))) + (if pid + (signal-process pid 'SIGKILL) + (xcb:+request exwm--connection + (make-instance 'xcb:KillClient :resource id)) + (xcb:flush exwm--connection)))) + +(defun exwm-manage--on-ConfigureRequest (data synthetic) + "Handle ConfigureRequest event." + (let ((obj (make-instance 'xcb:ConfigureRequest)) + buffer edges) + (xcb:unmarshal obj data) + (with-slots (window x y width height border-width) obj + (if (setq buffer (exwm--id->buffer window)) + ;; Send client message for managed windows + (progn + (setq edges (or (with-current-buffer buffer exwm--floating-edges) + (window-inside-absolute-pixel-edges + (get-buffer-window buffer)))) + (xcb:+request exwm--connection + (make-instance 'xcb:SendEvent + :propagate 0 :destination window + :event-mask xcb:EventMask:StructureNotify + :event (xcb:marshal + (make-instance + 'xcb:ConfigureNotify + :event window :window window + :above-sibling xcb:Window:None + :x (elt edges 0) :y (elt edges 1) + :width (- (elt edges 2) (elt edges 0)) + :height (- (elt edges 3) (elt edges 1)) + :border-width 0 :override-redirect 0) + exwm--connection)))) + ;; Configure unmanaged windows + (xcb:+request exwm--connection + (make-instance 'xcb:ConfigureWindow + :window window + :value-mask (logior xcb:ConfigWindow:X + xcb:ConfigWindow:Y + xcb:ConfigWindow:Width + xcb:ConfigWindow:Height + xcb:ConfigWindow:BorderWidth) + :x x :y y :width width :height height + :border-width border-width))))) + (xcb:flush exwm--connection)) + +(defun exwm-manage--on-MapRequest (data synthetic) + "Handle MapRequest event." + (let ((obj (make-instance 'xcb:MapRequest))) + (xcb:unmarshal obj data) + (exwm-manage--manage-window (slot-value obj 'window)))) + +(defun exwm-manage--on-UnmapNotify (data synthetic) + "Handle UnmapNotify event." + (unless synthetic + (let ((obj (make-instance 'xcb:UnmapNotify))) + (xcb:unmarshal obj data) + (exwm-manage--unmanage-window (slot-value obj 'window) t)))) + +(defun exwm-manage--on-DestroyNotify (data synthetic) + "Handle DestroyNotify event." + (unless synthetic + (let ((obj (make-instance 'xcb:DestroyNotify))) + (xcb:unmarshal obj data) + (exwm-manage--unmanage-window (slot-value obj 'window))))) + +(defun exwm-manage--init () + "Initialize manage module." + (xcb:+event exwm--connection 'xcb:ConfigureRequest + 'exwm-manage--on-ConfigureRequest) + (xcb:+event exwm--connection 'xcb:MapRequest 'exwm-manage--on-MapRequest) + (xcb:+event exwm--connection 'xcb:UnmapNotify 'exwm-manage--on-UnmapNotify) + (xcb:+event exwm--connection 'xcb:DestroyNotify + 'exwm-manage--on-DestroyNotify)) + + + +(provide 'exwm-manage) + +;;; exwm-manage.el ends here diff --git a/exwm-workspace.el b/exwm-workspace.el new file mode 100644 index 0000000..c225c43 --- /dev/null +++ b/exwm-workspace.el @@ -0,0 +1,230 @@ +;;; exwm-workspace.el --- Workspace Module for EXWM -*- lexical-binding: t -*- + +;; Copyright (C) 2015 Chris Feng + +;; Author: Chris Feng +;; Keywords: unix + +;; This file is not part of GNU Emacs. + +;; This file 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 file 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 file. If not, see . + +;;; Commentary: + +;; This module adds workspace support for EXWM. + +;; Todo: +;; + prevent from deleting frames of Emacs client (`frame-delete-functions') + +;;; Code: + +(defvar exwm-workspace-number 4 "Number of workspaces (1 ~ 10).") +(defvar exwm-workspace--list nil "List of all workspaces (Emacs frames).") +(defvar exwm-workspace--switch-map + (let ((map (make-sparse-keymap))) + (define-key map [t] (lambda () (interactive))) + (dotimes (i 10) + (define-key map (int-to-string i) + `(lambda () + (interactive) + (when (< ,i exwm-workspace-number) + (goto-history-element ,(1+ i)) + (exit-minibuffer))))) + (define-key map "\C-a" (lambda () (interactive) (goto-history-element 1))) + (define-key map "\C-e" (lambda () + (interactive) + (goto-history-element exwm-workspace-number))) + (define-key map "\C-g" 'abort-recursive-edit) + (define-key map "\C-]" 'abort-recursive-edit) + (define-key map "\C-j" 'exit-minibuffer) + ;; (define-key map "\C-m" 'exit-minibuffer) ;not working + (define-key map [return] 'exit-minibuffer) + (define-key map " " 'exit-minibuffer) + (define-key map "\C-f" 'previous-history-element) + (define-key map "\C-b" 'next-history-element) + ;; Alternative keys + (define-key map [right] 'previous-history-element) + (define-key map [left] 'next-history-element) + map) + "Keymap used for interactively switch workspace.") + +(defvar exwm-workspace--switch-history nil + "History for `read-from-minibuffer' to interactively switch workspace.") + +(defun exwm-workspace--update-switch-history () + "Update the history for switching workspace to reflect the latest status." + (let ((sequence (number-sequence 0 (1- exwm-workspace-number))) + (not-empty (make-vector exwm-workspace-number nil))) + (dolist (i exwm--id-buffer-alist) + (with-current-buffer (cdr i) + (setf (elt not-empty (cl-position exwm--frame exwm-workspace--list)) + t))) + (setq exwm-workspace--switch-history + (mapcar + (lambda (i) + (mapconcat + (lambda (j) + (format (if (= i j) "[%s]" " %s ") + (propertize + (int-to-string j) + 'face + (cond ((frame-parameter (elt exwm-workspace--list j) + 'exwm--urgency) + '(:foreground "orange")) + ((elt not-empty j) '(:foreground "green")) + (t nil))))) + sequence "")) + sequence)))) + +(defvar exwm-workspace--current nil "Current active workspace.") +(defvar exwm-workspace-current-index 0 "Index of current active workspace.") + +(defun exwm-workspace-switch (index &optional force) + "Switch to workspace INDEX. Query for INDEX if it's not specified. + +The optional FORCE option is for internal use only " + (interactive + (list + (let* ((history-add-new-input nil) ;prevent modifying history + (idx (read-from-minibuffer + "Workspace: " (elt exwm-workspace--switch-history + exwm-workspace-current-index) + exwm-workspace--switch-map nil + `(exwm-workspace--switch-history + . ,(1+ exwm-workspace-current-index))))) + (cl-position idx exwm-workspace--switch-history :test 'equal)))) + (unless (and (<= 0 index) (< index exwm-workspace-number)) + (user-error "[EXWM] Workspace index out of range: %d" index)) + (when (or force (/= exwm-workspace-current-index index)) + (select-frame-set-input-focus (elt exwm-workspace--list index)) + ;; Hide all workspaces but the selected one + (dotimes (i exwm-workspace-number) + (unless (= i index) (make-frame-invisible (elt exwm-workspace--list i)))) + (setq exwm-workspace--current (elt exwm-workspace--list index) + exwm-workspace-current-index index) + (setq default-minibuffer-frame (selected-frame)) + ;; Hide windows in other workspaces by preprending a space + (dolist (i exwm--id-buffer-alist) + (with-current-buffer (cdr i) + (let ((name (replace-regexp-in-string "^\\s-*" "" (buffer-name)))) + (rename-buffer (if (eq (selected-frame) exwm--frame) + name + (concat " " name)))))) + ;; Update demands attention flag + (set-frame-parameter (selected-frame) 'exwm--urgency nil) + ;; Update switch workspace history + (exwm-workspace--update-switch-history) + ;; Update _NET_CURRENT_DESKTOP + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_CURRENT_DESKTOP + :window exwm--root :data index)) + (xcb:flush exwm--connection))) + +(defun exwm-workspace-move-window (index &optional id) + "Move window ID to workspace INDEX." + (interactive + (list + (let* ((history-add-new-input nil) ;prevent modifying history + (idx (read-from-minibuffer + "Workspace: " (elt exwm-workspace--switch-history + exwm-workspace-current-index) + exwm-workspace--switch-map nil + `(exwm-workspace--switch-history + . ,(1+ exwm-workspace-current-index))))) + (cl-position idx exwm-workspace--switch-history :test 'equal)))) + (unless id (setq id (exwm--buffer->id (window-buffer)))) + (unless (and (<= 0 index) (< index exwm-workspace-number)) + (user-error "[EXWM] Workspace index out of range: %d" index)) + (when (/= exwm-workspace-current-index index) + (set-window-buffer (get-buffer-window (exwm--id->buffer id)) + (other-buffer)) + (let ((frame (elt exwm-workspace--list index))) + (with-current-buffer (exwm--id->buffer id) + (setq exwm--frame frame) + (rename-buffer + (concat " " (replace-regexp-in-string "^\\s-*" "" (buffer-name)))) + (if exwm--floating-frame + ;; Move the floating frame is enough + (xcb:+request exwm--connection + (make-instance 'xcb:ReparentWindow + :window (frame-parameter exwm--floating-frame + 'exwm-outer-id) + :parent (frame-parameter frame 'exwm-window-id) + :x 0 :y 0)) + ;; Move the window itself + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:NoEvent)) + (xcb:+request exwm--connection + (make-instance 'xcb:ReparentWindow + :window id + :parent (frame-parameter frame 'exwm-window-id) + :x 0 :y 0)) + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window id :value-mask xcb:CW:EventMask + :event-mask exwm--client-event-mask))))) + (xcb:flush exwm--connection) + (exwm-workspace--update-switch-history))) + +(defun exwm-workspace--init () + "Initialize workspace module." + (cl-assert (and (< 0 exwm-workspace-number) (>= 10 exwm-workspace-number))) + ;; Prevent unexpected exit + (setq confirm-kill-emacs + (lambda (prompt) + (pcase (length exwm--id-buffer-alist) + (0 (y-or-n-p prompt)) + (x (yes-or-no-p (format "[EXWM] %d window%s currently alive. %s" + x (if (= x 1) "" "s") prompt)))))) + ;; Initialize workspaces + (setq exwm-workspace--list (frame-list)) + (when (< 1 (length exwm-workspace--list)) + ;; Emacs client creates an extra (but unusable) frame + (dolist (i exwm-workspace--list) + (unless (frame-parameter i 'window-id) + (setq exwm-workspace--list (delq i exwm-workspace--list))))) + (cl-assert (= 1 (length exwm-workspace--list))) + ;; Configure the existing frame + (set-frame-parameter (car exwm-workspace--list) 'fullscreen 'fullboth) + ;; Create remaining frames + (dotimes (i (1- exwm-workspace-number)) + (nconc exwm-workspace--list + (list (make-frame '((window-system . x) (fullscreen . fullboth)))))) + ;; Configure workspaces + (dolist (i exwm-workspace--list) + (let ((window-id (string-to-int (frame-parameter i 'window-id))) + (outer-id (string-to-int (frame-parameter i 'outer-window-id)))) + ;; Save window IDs + (set-frame-parameter i 'exwm-window-id window-id) + (set-frame-parameter i 'exwm-outer-id outer-id) + ;; Set OverrideRedirect on all frames + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window outer-id :value-mask xcb:CW:OverrideRedirect + :override-redirect 1)) + ;; Select events on all virtual roots + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window window-id :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:SubstructureRedirect)))) + ;; Switch to the first workspace + (exwm-workspace-switch 0 t)) + + + +(provide 'exwm-workspace) + +;;; exwm-workspace.el ends here diff --git a/exwm.el b/exwm.el new file mode 100644 index 0000000..49c4380 --- /dev/null +++ b/exwm.el @@ -0,0 +1,706 @@ +;;; exwm.el --- Emacs X Window Manager -*- lexical-binding: t -*- + +;; Copyright (C) 2015 Chris Feng + +;; Author: Chris Feng +;; Keywords: unix + +;; This file is not part of GNU Emacs. + +;; This file 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 file 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 file. If not, see . + +;;; Commentary: + +;; Overview +;; -------- +;; EXWM (Emacs X Window Manager) turns Emacs into a full-featured tiling X +;; window manager. It's built on top of XELB, thus purely consists of Elisp +;; codes. Some features include: +;; + It's fully keyboard-driven. +;; - You have full access to all key bindings in Emacs. +;; - It allows you to bind additional key sequences with `exwm-input-set-key' +;; (just like `global-set-key'). +;; - It supports simulation keys (i.e., map one key sequence to another). +;; + Workspace support. +;; - EXWM support up to 10 workspaces. +;; + ICCCM/EWMH compliance. +;; - Note that the support for EWMH can never be complete since EXWM is not a +;; conventional window manager. + +;; How it works +;; ------------ +;; Emacs itself is an tiling window manager, though unfortunately not for +;; managing X things. EXWM is therefore created to overcome this limitation by +;; relating X concepts to Emacs ones as shown in the following table. +;; +;; +=============+=========+ +;; | X Window | Emacs | +;; +=============+=========+ +;; | window | buffer | +;; +-------------+---------+ +;; | container* | window | +;; +-------------+---------+ +;; | workspace / | frame** | +;; | decoration | | +;; +=============+=========+ +;; * Here a container means the parent of an X client window created by window +;; manager for layout management. +;; ** In EXWM, A frame usually acts as a workspace. But for a floating window, +;; it's the decoration around the top-level window. +;; +;; Each X client window corresponds to a dedicated buffer in EXWM mode. When +;; such a buffer is buried or unburied, the attached X client window is hide or +;; shown accordingly. The position and size of the X client window is then +;; determined by the Emacs window its corresponding buffer displayed in. +;; +;; A buffer in EXWM mode also records which workspace it belongs to, and its +;; attached X client window is made a child (in the sense of X) of the +;; workspace frame. The switch between workspaces is simply done by switching +;; corresponding Emacs frames. + +;; Installation & configuration +;; ---------------------------- +;; Here are the minimal steps to get EXWM working: +;; 0. Install xelb and xelb-util first. +;; 1. Put EXWM somewhere on your disk and make sure it's in `load-path'. +;; 2. In your Emacs init file, add following lines (modify accordingly): +;; +;; (require 'exwm) +;; ;; We always need a way to go back from char-mode to line-mode +;; (exwm-input-set-key (kbd "s-r") 'exwm-reset) +;; ;; Bind a key to switch workspace interactively +;; (exwm-input-set-key (kbd "s-w") 'exwm-workspace-switch) +;; ;; Use class name to name an EXWM buffer +;; (add-hook 'exwm-update-class-hook +;; (lambda () (rename-buffer exwm-class-name t))) +;; ;; Enable EXWM +;; (exwm-enable) +;; +;; 3. Make a file '~/.xinitrc' with the content +;; +;; exec emacs +;; +;; 4. Launch EXWM in a console with +;; +;; xinit +;; +;; You should refer to other resources on how to further configure '~/.xinitrc' +;; and other init scripts to improve the working experience. Besides, you +;; should hide the menu-bar, tool-bar, etc to increase the usable space. + +;; Interactive modes +;; ----------------- +;; There are two modes in EXWM to interact with an X client window: line mode +;; and char mode. They are analogous to those concepts in `ansi-term'. EXWM +;; buffers are created in line mode by default. +;; +;; In line mode, all key events are intercepted and then forwarded to the X +;; client window except +;; + it forms a mode-specific key sequence (which begins with 'C-c'), or +;; + it forms a key sequence bound with `exwm-input-set-key', or +;; + it forms a key sequence starting with a line mode prefix key, or +;; + it forms a key sequence in line mode simulation keys. +;; You can use 'C-c q' (bound to `exwm-input-send-next-key', can be 'C-u' +;; prefixed) to send these keys to the client. +;; +;; In char mode however, no key event is intercepted except those bound with +;; `exwm-input-set-key'. Therefore you will almost always need to +;; 'exwm-input-set-key' a key sequence to go from char mode to line mode. + +;; Related projects +;; ---------------- +;; EXWM is not the first attempt to make Emacs an X window manger; there is +;; another ancient project called XWEM (http://www.nongnu.org/xwem/) for +;; XEmacs, though it seems nobody have ever got it working on GNU Emacs. + +;; Todo: +;; + Add RandR support. +;; + Investigate DnD support (e.g. drag a chromium tab to another window). +;; + Auto hide minibuffer, or allow users to place it elsewhere. +;; + Add system tray support. + +;; References: +;; + dwm (http://dwm.suckless.org/) +;; + i3 wm (https://i3wm.org/) +;; + Also see references within each required library. + +;;; Code: + +(require 'xcb) +(require 'xcb-icccm) +(require 'xcb-ewmh) +(require 'exwm-workspace) +(require 'exwm-layout) +(require 'exwm-floating) +(require 'exwm-manage) +(require 'exwm-input) + +(defvar exwm-debug-on nil "Non-nil to turn on debug for EXWM.") + +(defmacro exwm--log (format-string &rest args) + "Print debug message." + (when exwm-debug-on + `(message (concat "[EXWM] " ,format-string) ,@args))) + +(defconst exwm--client-event-mask + (logior xcb:EventMask:StructureNotify xcb:EventMask:PropertyChange) + "Event mask set on all managed windows.") + +(defvar exwm--connection nil "X connection.") +(defvar exwm--root nil "Root window.") +(defvar exwm--id-buffer-alist nil "Alist of ( . )") + +(defsubst exwm--id->buffer (id) + "X window ID => Emacs buffer." + (cdr (assoc id exwm--id-buffer-alist))) + +(defsubst exwm--buffer->id (buffer) + "Emacs buffer => X window ID." + (car (rassoc buffer exwm--id-buffer-alist))) + +(defun exwm--lock (&rest args) ;args are for abnormal hook + "Lock (disable all events)." + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window exwm--root + :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:NoEvent)) + (xcb:flush exwm--connection)) + +(defun exwm--unlock (&rest args) ;args are for abnormal hook + "Unlock (enable all events)." + (xcb:+request exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window exwm--root + :value-mask xcb:CW:EventMask + :event-mask (logior xcb:EventMask:StructureNotify + xcb:EventMask:SubstructureRedirect))) + (xcb:flush exwm--connection)) + +(defun exwm-reset () + "Reset window to standard state: non-fullscreen, line-mode." + (interactive) + (with-current-buffer (window-buffer (selected-window)) + (when exwm--fullscreen (exwm-layout-unset-fullscreen)) + (exwm-input-grab-keyboard))) + +(defmacro exwm--with-current-id (id &rest body) + "Evaluate BODY in the context of the buffer corresponding to window ID." + (declare (indent 1)) + `(when ,id + (let ((buffer (exwm--id->buffer ,id))) + (when buffer + (with-current-buffer buffer ,@body))))) + +(defun exwm--update-window-type (id &optional force) + "Update _NET_WM_WINDOW_TYPE." + (exwm--with-current-id id + (unless (and exwm-window-type (not force)) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:ewmh:get-_NET_WM_WINDOW_TYPE + :window id)))) + (when reply ;nil when destroyed + (setq exwm-window-type (append (slot-value reply 'value) nil))))))) + +(defvar exwm-update-class-hook nil + "Normal hook run when window class is updated.") + +(defun exwm--update-class (id &optional force) + "Update WM_CLASS." + (exwm--with-current-id id + (unless (and exwm-instance-name exwm-class-name (not force)) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:icccm:get-WM_CLASS :window id)))) + (when reply ;nil when destroyed + (setq exwm-instance-name (slot-value reply 'instance-name) + exwm-class-name (slot-value reply 'class-name)) + (when (and exwm-instance-name exwm-class-name) + (run-hooks 'exwm-update-class-hook))))))) + +(defvar exwm-update-title-hook nil + "Normal hook run when window title is updated.") + +(defun exwm--update-utf8-title (id &optional force) + "Update _NET_WM_NAME." + (exwm--with-current-id id + (when (or force (not exwm-title)) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:ewmh:get-_NET_WM_NAME :window id)))) + (when reply ;nil when destroyed + (setq exwm-title (slot-value reply 'value)) + (when exwm-title + (setq exwm--title-is-utf8 t) + (run-hooks 'exwm-update-title-hook))))))) + +(defun exwm--update-ctext-title (id &optional force) + "Update WM_NAME." + (exwm--with-current-id id + (unless (or exwm--title-is-utf8 + (and exwm-title (not force))) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:icccm:get-WM_NAME :window id)))) + (when reply ;nil when destroyed + (setq exwm-title (slot-value reply 'value)) + (when exwm-title + (run-hooks 'exwm-update-title-hook))))))) + +(defun exwm--update-title (id) + "Update _NET_WM_NAME or WM_NAME." + (exwm--update-utf8-title id) + (exwm--update-ctext-title id)) + +(defun exwm--update-transient-for (id &optional force) + "Update WM_TRANSIENT_FOR." + (exwm--with-current-id id + (unless (and exwm-transient-for (not force)) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:icccm:get-WM_TRANSIENT_FOR + :window id)))) + (when reply ;nil when destroyed + (setq exwm-transient-for (slot-value reply 'value))))))) + +(defun exwm--update-normal-hints (id &optional force) + "Update WM_NORMAL_HINTS." + (exwm--with-current-id id + (unless (and (not force) + (or exwm--normal-hints-x exwm--normal-hints-y + exwm--normal-hints-width exwm--normal-hints-height + exwm--normal-hints-min-width exwm--normal-hints-min-height + exwm--normal-hints-max-width exwm--normal-hints-max-height + ;; FIXME: other fields + )) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:icccm:get-WM_NORMAL_HINTS + :window id)))) + (when (and reply (slot-value reply 'flags)) ;nil when destroyed + (with-slots (flags x y width height min-width min-height max-width + max-height base-width base-height ;; win-gravity + ) + reply + (unless (= 0 (logand flags xcb:icccm:WM_SIZE_HINTS:USPosition)) + (setq exwm--normal-hints-x x exwm--normal-hints-y y)) + (unless (= 0 (logand flags xcb:icccm:WM_SIZE_HINTS:USSize)) + (setq exwm--normal-hints-width width + exwm--normal-hints-height height)) + (unless (= 0 (logand flags xcb:icccm:WM_SIZE_HINTS:PMinSize)) + (setq exwm--normal-hints-min-width min-width + exwm--normal-hints-min-height min-height)) + (unless (= 0 (logand flags xcb:icccm:WM_SIZE_HINTS:PMaxSize)) + (setq exwm--normal-hints-max-width max-width + exwm--normal-hints-max-height max-height)) + (unless (or exwm--normal-hints-min-width + (= 0 (logand flags xcb:icccm:WM_SIZE_HINTS:PBaseSize))) + (setq exwm--normal-hints-min-width base-width + exwm--normal-hints-min-height base-height)) + ;; (unless (= 0 (logand flags xcb:icccm:WM_SIZE_HINTS:PWinGravity)) + ;; (setq exwm--normal-hints-win-gravity win-gravity)) + (setq exwm--fixed-size + (and exwm--normal-hints-min-width + exwm--normal-hints-min-height + exwm--normal-hints-max-width + exwm--normal-hints-max-height + (/= 0 exwm--normal-hints-min-width) + (/= 0 exwm--normal-hints-min-height) + (= exwm--normal-hints-min-width + exwm--normal-hints-max-width) + (= exwm--normal-hints-min-height + exwm--normal-hints-max-height))))))))) + +(defun exwm--update-hints (id &optional force) + "Update WM_HINTS." + (exwm--with-current-id id + (unless (and (not force) exwm--hints-input exwm--hints-urgency) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:icccm:get-WM_HINTS :window id)))) + (when (and reply (slot-value reply 'flags)) ;nil when destroyed + (with-slots (flags input) reply + (when flags + (unless (= 0 (logand flags xcb:icccm:WM_HINTS:InputHint)) + (setq exwm--hints-input (when input (= 1 input)))) + (unless (= 0 (logand flags xcb:icccm:WM_HINTS:UrgencyHint)) + (setq exwm--hints-urgency t)))) + (when (and exwm--hints-urgency + (not (eq exwm--frame exwm-workspace--current))) + (unless (frame-parameter exwm--frame 'exwm--urgency) + (set-frame-parameter exwm--frame 'exwm--urgency t) + (exwm-workspace--update-switch-history)))))))) + +(defun exwm--update-protocols (id &optional force) + "Update WM_PROTOCOLS." + (exwm--with-current-id id + (unless (and exwm--protocols (not force)) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:icccm:get-WM_PROTOCOLS + :window id)))) + (when reply ;nil when destroyed + (setq exwm--protocols (append (slot-value reply 'value) nil))))))) + +(defun exwm--update-state (id &optional force) + "Update WM_STATE." + (exwm--with-current-id id + (unless (and exwm-state (not force)) + (let ((reply (xcb:+request-unchecked+reply exwm--connection + (make-instance 'xcb:icccm:get-WM_STATE :window id)))) + (when reply ;nil when destroyed + (setq exwm-state (or (slot-value reply 'state) + ;; Default to normal state + xcb:icccm:WM_STATE:NormalState))))))) + +(defun exwm--on-PropertyNotify (data synthetic) + "Handle PropertyNotify event." + (let ((obj (make-instance 'xcb:PropertyNotify)) + atom window state + buffer) + (xcb:unmarshal obj data) + (setq id (slot-value obj 'window) + atom (slot-value obj 'atom) + exwm-input--timestamp (slot-value obj 'time) + state (slot-value obj 'state)) + (setq buffer (exwm--id->buffer id)) + (when (buffer-live-p buffer) + (with-current-buffer buffer + (cond ((= atom xcb:Atom:_NET_WM_WINDOW_TYPE) + (exwm--update-window-type id t)) + ((= atom xcb:Atom:WM_CLASS) + (exwm--update-class id t)) + ((= atom xcb:Atom:_NET_WM_NAME) + (exwm--update-utf8-title id t)) + ((= atom xcb:Atom:WM_NAME) + (exwm--update-ctext-title id t)) + ((= atom xcb:Atom:WM_TRANSIENT_FOR) + (exwm--update-transient-for id t)) + ((= atom xcb:Atom:WM_NORMAL_HINTS) + (exwm--update-normal-hints id t)) + ((= atom xcb:Atom:WM_HINTS) + (exwm--update-hints id t)) + ((= atom xcb:Atom:WM_PROTOCOLS) + (exwm--update-protocols id t)) + ((= atom xcb:Atom:WM_STATE) + (exwm--update-state id t)) + (t (exwm--log "Unhandled PropertyNotify: %s(%d)" + (x-get-atom-name atom) atom))))))) + +(defun exwm--on-ClientMessage (raw-data synthetic) + "Handle ClientMessage event." + (let ((obj (make-instance 'xcb:ClientMessage)) + type id data) + (xcb:unmarshal obj raw-data) + (setq type (slot-value obj 'type) + id (slot-value obj 'window) + data (slot-value (slot-value obj 'data) 'data32)) + (cond + ;; _NET_WM_MOVERESIZE + ((= type xcb:Atom:_NET_WM_MOVERESIZE) + (let ((direction (elt data 2)) + (buffer (exwm--id->buffer id))) + (unless (and buffer (with-current-buffer buffer + (not exwm--floating-frame))) + (cond ((= direction + xcb:ewmh:_NET_WM_MOVERESIZE_SIZE_KEYBOARD) + ;; FIXME + ) + ((= direction + xcb:ewmh:_NET_WM_MOVERESIZE_MOVE_KEYBOARD) + ;; FIXME + ) + ((= direction xcb:ewmh:_NET_WM_MOVERESIZE_CANCEL) + (exwm-floating--stop-moveresize)) + (t (exwm-floating--start-moveresize id direction)))))) + ;; _NET_REQUEST_FRAME_EXTENTS + ((= type xcb:Atom:_NET_REQUEST_FRAME_EXTENTS) + (let ((buffer (exwm--id->buffer id)) + left right top bottom) + (if (or (not buffer) + (with-current-buffer buffer + (not exwm--floating-frame))) + (setq left 0 right 0 top 0 bottom 0) + (setq left exwm-floating-border-width + right exwm-floating-border-width + top (+ exwm-floating-border-width (window-header-line-height)) + bottom (+ exwm-floating-border-width + (window-mode-line-height)))) + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_FRAME_EXTENTS + :window id :left left :right right + :top top :bottom bottom))) + (xcb:flush exwm--connection)) + ;; _NET_WM_STATE + ((= type xcb:Atom:_NET_WM_STATE) + (let ((action (elt data 0)) + (props (list (elt data 1) (elt data 2))) + (buffer (exwm--id->buffer id)) + props-new) + (when buffer ;ensure it's managed + (with-current-buffer buffer + ;; _NET_WM_STATE_MODAL + (when (memq xcb:Atom:_NET_WM_STATE_MODAL props) + (cond ((= action xcb:ewmh:_NET_WM_STATE_ADD) + (unless exwm--floating-frame + (exwm-floating--set-floating id)) + (push xcb:Atom:_NET_WM_STATE_MODAL props-new)) + ((= action xcb:ewmh:_NET_WM_STATE_REMOVE) + (when exwm--floating-frame + (exwm-floating--unset-floating id))) + ((= action xcb:ewmh:_NET_WM_STATE_TOGGLE) + (if exwm--floating-frame + (exwm-floating--unset-floating id) + (exwm-floating--set-floating id) + (push xcb:Atom:_NET_WM_STATE_MODAL props-new))))) + ;; _NET_WM_STATE_FULLSCREEN + (when (memq xcb:Atom:_NET_WM_STATE_FULLSCREEN props) + (cond ((= action xcb:ewmh:_NET_WM_STATE_ADD) + (unless exwm--fullscreen (exwm-layout-set-fullscreen id)) + (push xcb:Atom:_NET_WM_STATE_FULLSCREEN props-new)) + ((= action xcb:ewmh:_NET_WM_STATE_REMOVE) + (when exwm--fullscreen (exwm-layout-unset-fullscreen id))) + ((= action xcb:ewmh:_NET_WM_STATE_TOGGLE) + (if exwm--fullscreen + (exwm-layout-unset-fullscreen id) + (exwm-layout-set-fullscreen id) + (push xcb:Atom:_NET_WM_STATE_FULLSCREEN props-new))))) + ;; _NET_WM_STATE_DEMANDS_ATTENTION + ;; FIXME: check (may require other properties set) + (when (memq xcb:Atom:_NET_WM_STATE_DEMANDS_ATTENTION props) + (when (= action xcb:ewmh:_NET_WM_STATE_ADD) + (let ((idx (cl-position exwm--frame exwm-workspace--list))) + (unless (= idx exwm-workspace-current-index) + (set-frame-parameter exwm--frame 'exwm--urgency t) + (exwm-workspace--update-switch-history)))) + ;; xcb:ewmh:_NET_WM_STATE_REMOVE? + ;; xcb:ewmh:_NET_WM_STATE_TOGGLE? + ) + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_WM_STATE + :window id :data (vconcat props-new))) + (xcb:flush exwm--connection))))) + ((= type xcb:Atom:WM_PROTOCOLS) + (let ((type (elt data 0))) + (cond ((= type xcb:Atom:_NET_WM_PING) + (setq exwm--ping-lock nil)) + (t (exwm--log "Unhandled WM_PROTOCOLS of type: %d" type))))) + (t (exwm--log "Unhandled client message: %s" obj))))) + +(defun exwm--init-icccm-ewmh () + "Initialize ICCCM/EWMH support." + ;; Handle PropertyNotify event + (xcb:+event exwm--connection 'xcb:PropertyNotify 'exwm--on-PropertyNotify) + ;; Handle relevant client messages + ;; FIXME: WM_STATE client messages (normal => iconic) + ;; WM_COLORMAP_NOTIFY + (xcb:+event exwm--connection 'xcb:ClientMessage 'exwm--on-ClientMessage) + ;; Set _NET_SUPPORTED + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_SUPPORTED + :window exwm--root + :data (vector xcb:Atom:_NET_SUPPORTED + xcb:Atom:_NET_NUMBER_OF_DESKTOPS + xcb:Atom:_NET_DESKTOP_VIEWPORT + xcb:Atom:_NET_CURRENT_DESKTOP + xcb:Atom:_NET_WORKAREA + xcb:Atom:_NET_SUPPORTING_WM_CHECK + xcb:Atom:_NET_VIRTUAL_ROOTS + xcb:Atom:_NET_WM_MOVERESIZE + xcb:Atom:_NET_REQUEST_FRAME_EXTENTS + xcb:Atom:_NET_FRAME_EXTENTS + xcb:Atom:_NET_WM_NAME + ;; + xcb:Atom:_NET_WM_WINDOW_TYPE + xcb:Atom:_NET_WM_WINDOW_TYPE_TOOLBAR + xcb:Atom:_NET_WM_WINDOW_TYPE_MENU + xcb:Atom:_NET_WM_WINDOW_TYPE_UTILITY + xcb:Atom:_NET_WM_WINDOW_TYPE_SPLASH + xcb:Atom:_NET_WM_WINDOW_TYPE_DIALOG + xcb:Atom:_NET_WM_WINDOW_TYPE_DROPDOWN_MENU + xcb:Atom:_NET_WM_WINDOW_TYPE_POPUP_MENU + xcb:Atom:_NET_WM_WINDOW_TYPE_TOOLTIP + xcb:Atom:_NET_WM_WINDOW_TYPE_NOTIFICATION + xcb:Atom:_NET_WM_WINDOW_TYPE_COMBO + xcb:Atom:_NET_WM_WINDOW_TYPE_DND + xcb:Atom:_NET_WM_WINDOW_TYPE_NORMAL + ;; + xcb:Atom:_NET_WM_STATE + xcb:Atom:_NET_WM_STATE_MODAL + xcb:Atom:_NET_WM_STATE_FULLSCREEN + xcb:Atom:_NET_WM_STATE_DEMANDS_ATTENTION + ;; FIXME: more? + ))) + ;; Create a child window for setting _NET_SUPPORTING_WM_CHECK + (let ((new-id (xcb:generate-id exwm--connection))) + (xcb:+request exwm--connection + (make-instance 'xcb:CreateWindow + :depth 0 :wid new-id :parent exwm--root + :x -1 :y -1 :width 1 :height 1 + :border-width 0 :class xcb:WindowClass:CopyFromParent + :visual 0 :value-mask xcb:CW:OverrideRedirect + :override-redirect 1)) + (dolist (i (list exwm--root new-id)) + ;; Set _NET_SUPPORTING_WM_CHECK + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_SUPPORTING_WM_CHECK + :window i :data new-id)) + ;; Set _NET_WM_NAME + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_WM_NAME + :window i :data "EXWM")))) + ;; Set _NET_NUMBER_OF_DESKTOPS + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_NUMBER_OF_DESKTOPS + :window exwm--root :data exwm-workspace-number)) + ;; Set _NET_DESKTOP_VIEWPORT + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_DESKTOP_VIEWPORT + :window exwm--root + :data (make-vector (* 2 exwm-workspace-number) 0))) + ;; Set _NET_WORKAREA (with minibuffer and bottom mode-line excluded) + (let* ((workareas + (vconcat (window-absolute-pixel-edges (get-largest-window t)))) + (workareas (mapconcat (lambda (i) workareas) + (make-list exwm-workspace-number 0) []))) + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_WORKAREA + :window exwm--root :data workareas))) + ;; Set _NET_VIRTUAL_ROOTS + (xcb:+request exwm--connection + (make-instance 'xcb:ewmh:set-_NET_VIRTUAL_ROOTS + :window exwm--root + :data (vconcat (mapcar + (lambda (i) + (frame-parameter i 'exwm-window-id)) + exwm-workspace--list)))) + (xcb:flush exwm--connection)) + +(defvar exwm-init-hook nil + "Normal hook run when EXWM has just finished initialization.") + +(defun exwm-init (&optional frame) + "Initialize EXWM." + (if (not (eq 'x (framep (or frame (selected-frame))))) + (exwm--log "Not running under X environment") + (unless exwm--connection + (setq exwm--connection (xcb:connect-to-socket)) + (set-process-query-on-exit-flag (slot-value exwm--connection 'process) + nil) ;prevent query message on exit + (setq exwm--root + (slot-value (car (slot-value + (xcb:get-setup exwm--connection) 'roots)) + 'root)) + (if (xcb:+request-checked+request-check exwm--connection + (make-instance 'xcb:ChangeWindowAttributes + :window exwm--root :value-mask xcb:CW:EventMask + :event-mask xcb:EventMask:SubstructureRedirect)) + ;; Other window manager is running + (progn (xcb:disconnect exwm--connection) + (setq exwm--connection nil) + (exwm-enable 'undo) + (exwm--log "Other window manager detected")) + ;; Initialize ICCCM/EWMH support + ;; (xcb:icccm:init exwm--connection) + (xcb:ewmh:init exwm--connection) + (exwm--lock) + (exwm-workspace--init) + (exwm--init-icccm-ewmh) + (exwm-layout--init) + (exwm-floating--init) + (exwm-manage--init) + (exwm-input--init) + (exwm--unlock) + ;; Disable events during new frame creation + (add-hook 'before-make-frame-hook 'exwm--lock) + (add-hook 'after-make-frame-functions 'exwm--unlock) + ;; Manage exiting windows + (exwm-manage--scan) + (run-hooks 'exwm-init-hook))))) + +(defvar exwm-mode-map + (let ((map (make-sparse-keymap))) + (define-key map "\C-ck" 'exwm-input-release-keyboard) + (define-key map "\C-cf" 'exwm-layout-set-fullscreen) + (define-key map "\C-cm" 'exwm-floating-toggle-floating) + (define-key map "\C-cq" 'exwm-input-send-next-key) + (define-key map "\C-cv" 'exwm-workspace-move-window) + map) + "Keymap for `exwm-mode'.") + +(define-derived-mode exwm-mode nil "EXWM" + "Major mode for managing X windows. + +\\{exwm-mode-map}" + ;; Internal variables + (make-local-variable 'exwm--id) ;window id + (set (make-local-variable 'exwm--frame) nil) ;workspace frame + (set (make-local-variable 'exwm--floating-frame) nil) ;floating frame + (set (make-local-variable 'exwm--floating-edges) nil) ;four edges + (set (make-local-variable 'exwm--fullscreen) nil) ;used in fullscreen + (set (make-local-variable 'exwm--floating-frame-geometry) nil) ;in fullscreen + (set (make-local-variable 'exwm--fixed-size) nil) ;fixed size + ;; Properties + (set (make-local-variable 'exwm-window-type) nil) + (set (make-local-variable 'exwm--geometry) nil) + (set (make-local-variable 'exwm-class-name) nil) + (set (make-local-variable 'exwm-instance-name) nil) + (set (make-local-variable 'exwm-title) nil) + (set (make-local-variable 'exwm--title-is-utf8) nil) + (set (make-local-variable 'exwm-transient-for) nil) + ;; _NET_WM_NORMAL_HINTS + (set (make-local-variable 'exwm--normal-hints-x) nil) + (set (make-local-variable 'exwm--normal-hints-y) nil) + (set (make-local-variable 'exwm--normal-hints-width) nil) + (set (make-local-variable 'exwm--normal-hints-height) nil) + (set (make-local-variable 'exwm--normal-hints-min-width) nil) + (set (make-local-variable 'exwm--normal-hints-min-height) nil) + (set (make-local-variable 'exwm--normal-hints-max-width) nil) + (set (make-local-variable 'exwm--normal-hints-max-height) nil) + ;; (set (make-local-variable 'exwm--normal-hints-win-gravity) nil) + ;; WM_HINTS + (set (make-local-variable 'exwm--hints-input) nil) ;FIXME + (set (make-local-variable 'exwm--hints-urgency) nil) + ;; + (set (make-local-variable 'exwm--protocols) nil) + (set (make-local-variable 'exwm-state) nil) + ;; Change major-mode is not allowed + (set (make-local-variable 'change-major-mode-hook) 'kill-buffer) + ;; + (setq mode-name + '(:eval (propertize "EXWM" 'face + (when (cl-some (lambda (i) + (frame-parameter i + 'exwm--urgency)) + exwm-workspace--list) + 'font-lock-warning-face)))) + ;; Kill buffer -> close window + (set (make-local-variable 'kill-buffer-query-functions) + (list (lambda () + (exwm-manage--close-window exwm--id (current-buffer)) + nil))) + (setq buffer-read-only t + left-margin-width nil + right-margin-width nil + left-fringe-width 0 + right-fringe-width 0 + vertical-scroll-bar nil)) + +(defun exwm-enable (&optional undo) + "Enable/Disable EXWM" + (setq frame-resize-pixelwise t) ;mandatory; before init + (if (eq undo 'undo) + (progn (remove-hook 'window-setup-hook 'exwm-init) + (remove-hook 'after-make-frame-functions 'exwm-init)) + (add-hook 'window-setup-hook 'exwm-init t) ;for Emacs + (add-hook 'after-make-frame-functions 'exwm-init t))) ;for Emacs Client + + + +(provide 'exwm) + +;;; exwm.el ends here