diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | COPYING | 674 | ||||
| -rw-r--r-- | README | 8 | ||||
| -rw-r--r-- | README.md | 13 | ||||
| -rw-r--r-- | exwm-core.el | 155 | ||||
| -rw-r--r-- | exwm-floating.el | 51 | ||||
| -rw-r--r-- | exwm-input.el | 94 | ||||
| -rw-r--r-- | exwm-layout.el | 21 | ||||
| -rw-r--r-- | exwm-manage.el | 27 | ||||
| -rw-r--r-- | exwm-randr.el | 27 | ||||
| -rw-r--r-- | exwm-workspace.el | 58 | ||||
| -rw-r--r-- | exwm.el | 298 |
12 files changed, 382 insertions, 1045 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000000..c531d9867f6c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*.elc diff --git a/COPYING b/COPYING deleted file mode 100644 index 94a9ed024d38..000000000000 --- a/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/README b/README deleted file mode 100644 index 5e2bedd49356..000000000000 --- a/README +++ /dev/null @@ -1,8 +0,0 @@ -Emacs X Window Manager -====================== - -EXWM (Emacs X Window Manager) turns Emacs into a full-featured tiling X window -manager. Please check the wiki (https://github.com/ch11ng/exwm/wiki) for more -details. - -EXWM is built on top of XELB (https://github.com/ch11ng/xelb). diff --git a/README.md b/README.md new file mode 100644 index 000000000000..5d18fa6c85ab --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +Emacs X Window Manager +====================== + +EXWM (Emacs X Window Manager) is a full-featured tiling X window manager for +Emacs built on top of [XELB](https://github.com/ch11ng/xelb). +It features: ++ Fully keyboard-driven operation ++ Hybrid layout modes (tiling & stacking) ++ Workspace support ++ ICCCM/EWMH compliance ++ Basic RandR support (optional) + +Please check the [wiki](https://github.com/ch11ng/exwm/wiki) for more details. diff --git a/exwm-core.el b/exwm-core.el new file mode 100644 index 000000000000..9810de4f749e --- /dev/null +++ b/exwm-core.el @@ -0,0 +1,155 @@ +;;; exwm-core.el --- Core definitions -*- lexical-binding: t -*- + +;; Copyright (C) 2015 Free Software Foundation, Inc. + +;; Author: Chris Feng <chris.w.feng@gmail.com> + +;; This file is part of GNU Emacs. + +;; GNU Emacs 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. + +;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>. + +;;; Commentary: + +;; This module includes core definitions of variables, macros, functions, etc +;; shared by various other modules. + +;;; Code: + +(require 'xcb) +(require 'xcb-icccm) +(require 'xcb-ewmh) + +(eval-and-compile + (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))) + +(defun exwm--make-emacs-idle-for (seconds) + "Put Emacs in idle state for SECONDS seconds." + (with-timeout (seconds) (read-event))) + +(defvar exwm--connection nil "X connection.") +(defvar exwm--root nil "Root window.") +(defvar exwm--id-buffer-alist nil "Alist of (<X window ID> . <Emacs buffer>).") + +(defsubst exwm--id->buffer (id) + "X window ID => Emacs buffer." + (cdr (assoc id exwm--id-buffer-alist))) + +(defsubst exwm--buffer->id (buffer) + "Emacs buffer BUFFER => X window ID." + (car (rassoc buffer exwm--id-buffer-alist))) + +(defun exwm--lock (&rest _args) + "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) + "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)) + +(defconst exwm--client-event-mask + (logior xcb:EventMask:StructureNotify xcb:EventMask:PropertyChange) + "Event mask set on all managed windows.") + +;; Internal variables +(defvar-local exwm--id nil) ;window ID +(defvar-local exwm--frame nil) ;workspace frame +(defvar-local exwm--floating-frame nil) ;floating frame +(defvar-local exwm--floating-edges nil) ;four edges +(defvar-local exwm--fullscreen nil) ;used in fullscreen +(defvar-local exwm--floating-frame-geometry nil) ;in fullscreen +(defvar-local exwm--fixed-size nil) ;fixed size +(defvar-local exwm--on-KeyPress ;KeyPress event handler + #'exwm-input--on-KeyPress-line-mode) +;; Properties +(defvar-local exwm-window-type nil "_NET_WM_WINDOW_TYPE.") +(defvar-local exwm--geometry nil) +(defvar-local exwm-class-name nil "Class name in WM_CLASS.") +(defvar-local exwm-instance-name nil "Instance name in WM_CLASS.") +(defvar-local exwm-title nil "Window title (either _NET_WM_NAME or WM_NAME)") +(defvar-local exwm--title-is-utf8 nil) +(defvar-local exwm-transient-for nil "WM_TRANSIENT_FOR.") +(defvar-local exwm--protocols nil) +(defvar-local exwm-state nil "WM_STATE.") +;; _NET_WM_NORMAL_HINTS +(defvar-local exwm--normal-hints-x nil) +(defvar-local exwm--normal-hints-y nil) +(defvar-local exwm--normal-hints-width nil) +(defvar-local exwm--normal-hints-height nil) +(defvar-local exwm--normal-hints-min-width nil) +(defvar-local exwm--normal-hints-min-height nil) +(defvar-local exwm--normal-hints-max-width nil) +(defvar-local exwm--normal-hints-max-height nil) +;; (defvar-local exwm--normal-hints-win-gravity nil) +;; WM_HINTS +(defvar-local exwm--hints-input nil) ;FIXME +(defvar-local exwm--hints-urgency nil) + +(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}" + ;; + (setq mode-name + '(:eval (propertize "EXWM" 'face + (when (cl-some (lambda (i) + (frame-parameter i + 'exwm--urgency)) + exwm-workspace--list) + 'font-lock-warning-face)))) + ;; Change major-mode is not allowed + (add-hook 'change-major-mode-hook #'kill-buffer nil t) + ;; Kill buffer -> close window + (add-hook 'kill-buffer-query-functions + (lambda () + (exwm-manage--close-window exwm--id (current-buffer)) + nil) + nil t) + (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)) + + + +(provide 'exwm-core) + +;;; exwm-core.el ends here diff --git a/exwm-floating.el b/exwm-floating.el index 851a586decda..6bb635a5657d 100644 --- a/exwm-floating.el +++ b/exwm-floating.el @@ -1,24 +1,23 @@ ;;; exwm-floating.el --- Floating Module for EXWM -*- lexical-binding: t -*- -;; Copyright (C) 2015 Chris Feng +;; Copyright (C) 2015 Free Software Foundation, Inc. ;; Author: Chris Feng <chris.w.feng@gmail.com> -;; Keywords: unix -;; This file is not part of GNU Emacs. +;; This file is part of GNU Emacs. -;; This file is free software: you can redistribute it and/or modify +;; GNU Emacs 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, +;; GNU Emacs 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 <http://www.gnu.org/licenses/>. +;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. ;;; Commentary: @@ -31,6 +30,8 @@ ;;; Code: (require 'xcb-cursor) +(require 'exwm-core) +(eval-when-compile (require 'exwm-workspace)) (defvar exwm-floating-border-width 1 "Border width of the floating window.") (defvar exwm-floating-border-color "blue" @@ -41,6 +42,18 @@ (defvar exwm-floating-exit-hook nil "Normal hook run when a window has exited floating state.") +;; 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) + +;;;###autoload (defun exwm-floating--set-floating (id) "Make window ID floating." (interactive) @@ -66,8 +79,8 @@ (internal-border-width . ,exwm-floating-border-width) (unsplittable . t))) ;and fix the size later (exwm--unlock)))) - (frame-id (string-to-int (frame-parameter frame 'window-id))) - (outer-id (string-to-int (frame-parameter frame 'outer-window-id))) + (frame-id (string-to-number (frame-parameter frame 'window-id))) + (outer-id (string-to-number (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)) @@ -189,6 +202,7 @@ (select-window window)) (run-hooks 'exwm-floating-setup-hook)) +;;;###autoload (defun exwm-floating--unset-floating (id) "Make window ID non-floating." (interactive) @@ -223,6 +237,7 @@ (select-window window))) (run-hooks 'exwm-floating-exit-hook)) +;;;###autoload (defun exwm-floating-toggle-floating () "Toggle the current window between floating and non-floating states." (interactive) @@ -234,10 +249,11 @@ (defvar exwm-floating--moveresize-calculate nil "Calculate move/resize parameters [frame-id event-mask x y width height].") +;;;###autoload (defun exwm-floating--start-moveresize (id &optional type) "Start move/resize." (let ((buffer (exwm--id->buffer id)) - frame frame-id cursor) + frame frame-id x y width height cursor) (when (and buffer (setq frame (with-current-buffer buffer exwm--floating-frame)) (setq frame-id (frame-parameter frame 'exwm-outer-id)) @@ -372,14 +388,16 @@ :cursor cursor :time xcb:Time:CurrentTime))))))) -(defun exwm-floating--stop-moveresize (&rest args) +;;;###autoload +(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-calculate nil)) -(defun exwm-floating--do-moveresize (data synthetic) +;;;###autoload +(defun exwm-floating--do-moveresize (data _synthetic) "Perform move/resize." (when exwm-floating--moveresize-calculate (let ((obj (make-instance 'xcb:MotionNotify)) @@ -401,17 +419,6 @@ :width (elt result 4) :height (elt result 5))) (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 diff --git a/exwm-input.el b/exwm-input.el index eb53b41b8c20..69d2aff8e228 100644 --- a/exwm-input.el +++ b/exwm-input.el @@ -1,24 +1,23 @@ ;;; exwm-input.el --- Input Module for EXWM -*- lexical-binding: t -*- -;; Copyright (C) 2015 Chris Feng +;; Copyright (C) 2015 Free Software Foundation, Inc. ;; Author: Chris Feng <chris.w.feng@gmail.com> -;; Keywords: unix -;; This file is not part of GNU Emacs. +;; This file is part of GNU Emacs. -;; This file is free software: you can redistribute it and/or modify +;; GNU Emacs 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, +;; GNU Emacs 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 <http://www.gnu.org/licenses/>. +;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. ;;; Commentary: @@ -33,11 +32,13 @@ ;; + 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. +;; + Investigate DnD support (e.g. drag a chromium tab to another window). ;;; Code: (require 'xcb-keysyms) -(require 'exwm-floating) +(require 'exwm-core) +(eval-when-compile (require 'exwm-workspace)) (defvar exwm-input-move-event 's-down-mouse-1 "Emacs event to start moving a window.") @@ -99,7 +100,7 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") (setq exwm-input--focus-window window) (when exwm-input--timer (cancel-timer exwm-input--timer)) (setq exwm-input--timer - (run-with-timer 0.01 nil 'exwm-input--update-focus))) + (run-with-timer 0.01 nil #'exwm-input--update-focus))) (setq exwm-input--redirected nil)))) (defun exwm-input--on-focus-in () @@ -131,6 +132,11 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") (redirect-frame-focus exwm--floating-frame exwm--frame)))))) (setq exwm-input--focus-window nil)))) +(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.") + (defun exwm-input--finish-key-sequence () "Mark the end of a key sequence (with the aid of `pre-command-hook')." (when (and exwm-input--during-key-sequence @@ -140,7 +146,7 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") (setq exwm-input--temp-line-mode nil) (exwm-input--release-keyboard)))) -(defun exwm-input--on-MappingNotify (data synthetic) +(defun exwm-input--on-MappingNotify (data _synthetic) "Handle MappingNotify event." (let ((obj (make-instance 'xcb:MappingNotify))) (xcb:unmarshal obj data) @@ -157,7 +163,7 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") (xcb:keysyms:update-keyboard-mapping exwm--connection first-keycode count)))))) -(defun exwm-input--on-ButtonPress (data synthetic) +(defun exwm-input--on-ButtonPress (data _synthetic) "Handle ButtonPress event." (let ((obj (make-instance 'xcb:ButtonPress)) (mode xcb:Allow:SyncPointer)) @@ -167,8 +173,8 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") (cond ((and (= state exwm-input--move-mask) (= detail exwm-input--move-keysym)) ;; Move - (exwm-floating--start-moveresize event - xcb:ewmh:_NET_WM_MOVERESIZE_MOVE)) + (exwm-floating--start-moveresize + event xcb:ewmh:_NET_WM_MOVERESIZE_MOVE)) ((and (= state exwm-input--resize-mask) (= detail exwm-input--resize-keysym)) ;; Resize @@ -182,7 +188,7 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") (make-instance 'xcb:AllowEvents :mode mode :time xcb:Time:CurrentTime)) (xcb:flush exwm--connection))) -(defun exwm-input--on-KeyPress (data synthetic) +(defun exwm-input--on-KeyPress (data _synthetic) "Handle KeyPress event." (let ((obj (make-instance 'xcb:KeyPress))) (xcb:unmarshal obj data) @@ -194,6 +200,12 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") (defvar exwm-input--global-keys nil "Global key bindings.") (defvar exwm-input--global-prefix-keys nil "List of prefix keys of global key bindings.") +(defvar exwm-input-prefix-keys + '(?\C-x ?\C-u ?\C-h ?\M-x ?\M-` ?\M-! ?\M-& ?\M-:) + "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-global-prefix-keys () "Update `exwm-input--global-prefix-keys'." @@ -229,14 +241,10 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") (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.") - -(cl-defmethod exwm-input--on-KeyPress-line-mode ((obj xcb:KeyPress)) +;;;###autoload +(defun exwm-input--on-KeyPress-line-mode (key-press) "Parse X KeyPress event to Emacs key event and then feed the command loop." - (with-slots (detail state) obj + (with-slots (detail state) key-press (let ((keysym (xcb:keysyms:keycode->keysym exwm--connection detail state)) event minibuffer-window mode) (when (and keysym @@ -256,16 +264,16 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") :time xcb:Time:CurrentTime)) (xcb:flush exwm--connection)))) -(cl-defmethod exwm-input--on-KeyPress-char-mode ((obj xcb:KeyPress)) +(defun exwm-input--on-KeyPress-char-mode (key-press) "Handle KeyPress event in char-mode." - (with-slots (detail state) obj + (with-slots (detail state) key-press (let ((keysym (xcb:keysyms:keycode->keysym exwm--connection detail state)) event) (when (and keysym (setq event (xcb:keysyms:keysym->event keysym state))) (when (eq major-mode 'exwm-mode) (setq exwm-input--temp-line-mode t exwm-input--during-key-sequence t) - (exwm-input--grab-keyboard)) ;grab keyboard temporarily + (exwm-input--grab-keyboard)) ;grab keyboard temporarily (push event unread-command-events)))) (xcb:+request exwm--connection (make-instance 'xcb:AllowEvents @@ -285,7 +293,7 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") :pointer-mode xcb:GrabMode:Async :keyboard-mode xcb:GrabMode:Sync)) (exwm--log "Failed to grab keyboard for #x%x" id)) - (setq exwm--on-KeyPress 'exwm-input--on-KeyPress-line-mode))) + (setq exwm--on-KeyPress #'exwm-input--on-KeyPress-line-mode))) (defun exwm-input--release-keyboard (&optional id) "Ungrab all key events on window ID." @@ -296,8 +304,9 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") :key xcb:Grab:Any :grab-window id :modifiers xcb:ModMask:Any)) (exwm--log "Failed to release keyboard for #x%x" id)) - (setq exwm--on-KeyPress 'exwm-input--on-KeyPress-char-mode))) + (setq exwm--on-KeyPress #'exwm-input--on-KeyPress-char-mode))) +;;;###autoload (defun exwm-input-grab-keyboard (&optional id) "Switch to line-mode." (interactive) @@ -314,6 +323,7 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") (down-mouse-1 . exwm-input-release-keyboard)))))) (force-mode-line-update)) +;;;###autoload (defun exwm-input-release-keyboard (&optional id) "Switch to char-mode." (interactive) @@ -353,6 +363,7 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") exwm--connection)))) (xcb:flush exwm--connection))) +;;;###autoload (defun exwm-input-send-next-key (times) "Send next key to client window." (interactive "p") @@ -376,19 +387,11 @@ It's updated in several occasions, and only used by `exwm-input--set-focus'.") ;; (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-! ?\M-& ?\M-:) - "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) + (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) @@ -403,14 +406,12 @@ SIMULATION-KEYS is a list of alist (key-sequence1 . key-sequence2)." (defun exwm-input-send-simulation-key (times) "Fake a key event according to last input key sequence." (interactive "p") - (let ((pair (assoc (this-single-command-keys) - exwm-input--simulation-keys)) - key) + (let ((pair (assoc (this-single-command-keys) exwm-input--simulation-keys))) (when pair (setq pair (cdr pair)) (unless (listp pair) (setq pair (list pair))) - (dotimes (i times) + (dotimes (_ times) (dolist (j pair) (exwm-input--fake-key j)))))) @@ -427,17 +428,18 @@ SIMULATION-KEYS is a list of alist (key-sequence1 . key-sequence2)." 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) + #'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) + #'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) + (add-hook 'pre-command-hook #'exwm-input--finish-key-sequence) ;; Update focus when buffer list updates - (add-hook 'buffer-list-update-hook 'exwm-input--on-buffer-list-update) - (add-hook 'focus-in-hook 'exwm-input--on-focus-in) + (add-hook 'buffer-list-update-hook #'exwm-input--on-buffer-list-update) + (add-hook 'focus-in-hook #'exwm-input--on-focus-in) ;; Update prefix keys for global keys (exwm-input--update-global-prefix-keys)) diff --git a/exwm-layout.el b/exwm-layout.el index fe1645f0fb58..a14651a46df9 100644 --- a/exwm-layout.el +++ b/exwm-layout.el @@ -1,24 +1,23 @@ ;;; exwm-layout.el --- Layout Module for EXWM -*- lexical-binding: t -*- -;; Copyright (C) 2015 Chris Feng +;; Copyright (C) 2015 Free Software Foundation, Inc. ;; Author: Chris Feng <chris.w.feng@gmail.com> -;; Keywords: unix -;; This file is not part of GNU Emacs. +;; This file is part of GNU Emacs. -;; This file is free software: you can redistribute it and/or modify +;; GNU Emacs 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, +;; GNU Emacs 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 <http://www.gnu.org/licenses/>. +;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. ;;; Commentary: @@ -26,6 +25,10 @@ ;;; Code: +(require 'exwm-core) +(eval-when-compile (require 'exwm-workspace)) + +;;;###autoload (defun exwm-layout--show (id &optional window) "Show window ID exactly fit in the Emacs window WINDOW." (exwm--log "Show #x%x in %s" id window) @@ -68,6 +71,7 @@ exwm--connection)))) (xcb:flush exwm--connection)) +;;;###autoload (defun exwm-layout--hide (id) "Hide window ID." (unless (eq xcb:icccm:WM_STATE:IconicState ;already hidden @@ -89,6 +93,7 @@ :icon xcb:Window:None)) (xcb:flush exwm--connection))) +;;;###autoload (defun exwm-layout-set-fullscreen (&optional id) "Make window ID fullscreen." (interactive) @@ -248,9 +253,9 @@ (defun exwm-layout--init () "Initialize layout module." ;; Auto refresh layout - (add-hook 'window-configuration-change-hook 'exwm-layout--refresh) + (add-hook 'window-configuration-change-hook #'exwm-layout--refresh) ;; Refresh when minibuffer grows - (add-hook 'minibuffer-setup-hook 'exwm-layout--on-minibuffer-setup t)) + (add-hook 'minibuffer-setup-hook #'exwm-layout--on-minibuffer-setup t)) diff --git a/exwm-manage.el b/exwm-manage.el index 648b42b8fed5..a8d0e592a82e 100644 --- a/exwm-manage.el +++ b/exwm-manage.el @@ -1,25 +1,24 @@ ;;; exwm-manage.el --- Window Management Module for -*- lexical-binding: t -*- ;;; EXWM -;; Copyright (C) 2015 Chris Feng +;; Copyright (C) 2015 Free Software Foundation, Inc. ;; Author: Chris Feng <chris.w.feng@gmail.com> -;; Keywords: unix -;; This file is not part of GNU Emacs. +;; This file is part of GNU Emacs. -;; This file is free software: you can redistribute it and/or modify +;; GNU Emacs 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, +;; GNU Emacs 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 <http://www.gnu.org/licenses/>. +;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. ;;; Commentary: @@ -27,7 +26,8 @@ ;;; Code: -(require 'exwm-input) +(require 'exwm-core) +(eval-when-compile (require 'exwm-workspace)) (defvar exwm-manage-finish-hook nil "Normal hook run after a window is just managed, in the context of the @@ -208,6 +208,7 @@ corresponding buffer.") "Non-nil indicates EXWM is pinging a window.") (defvar exwm-manage-ping-timeout 3 "Seconds to wait before killing a client.") +;;;###autoload (defun exwm-manage--close-window (id &optional buffer) "Close window ID in a proper way." (catch 'return @@ -269,7 +270,7 @@ corresponding buffer.") (make-instance 'xcb:KillClient :resource id)) (xcb:flush exwm--connection)))) -(defun exwm-manage--on-ConfigureRequest (data synthetic) +(defun exwm-manage--on-ConfigureRequest (data _synthetic) "Handle ConfigureRequest event." (let ((obj (make-instance 'xcb:ConfigureRequest)) buffer edges) @@ -316,7 +317,7 @@ corresponding buffer.") :sibling sibling :stack-mode stack-mode))))) (xcb:flush exwm--connection)) -(defun exwm-manage--on-MapRequest (data synthetic) +(defun exwm-manage--on-MapRequest (data _synthetic) "Handle MapRequest event." (let ((obj (make-instance 'xcb:MapRequest))) (xcb:unmarshal obj data) @@ -347,11 +348,11 @@ corresponding buffer.") (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) + #'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)) + #'exwm-manage--on-DestroyNotify)) diff --git a/exwm-randr.el b/exwm-randr.el index 57ad569e2282..d14e0974c7ad 100644 --- a/exwm-randr.el +++ b/exwm-randr.el @@ -1,24 +1,23 @@ ;;; exwm-randr.el --- RandR Module for EXWM -*- lexical-binding: t -*- -;; Copyright (C) 2015 Chris Feng +;; Copyright (C) 2015 Free Software Foundation, Inc. ;; Author: Chris Feng <chris.w.feng@gmail.com> -;; Keywords: unix -;; This file is not part of GNU Emacs. +;; This file is part of GNU Emacs. -;; This file is free software: you can redistribute it and/or modify +;; GNU Emacs 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, +;; GNU Emacs 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 <http://www.gnu.org/licenses/>. +;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. ;;; Commentary: @@ -42,6 +41,8 @@ ;;; Code: (require 'xcb-randr) +(require 'exwm-core) +(eval-when-compile (require 'exwm-workspace)) (defvar exwm-randr-workspace-output-plist nil) @@ -60,7 +61,7 @@ :output output :config-timestamp config-timestamp)) (setq name ;UTF-8 encoded - (decode-coding-string (apply 'unibyte-string name) 'utf-8)) + (decode-coding-string (apply #'unibyte-string name) 'utf-8)) (if (or (/= connection xcb:randr:Connection:Connected) (= 0 crtc)) ;FIXME (plist-put output-plist name nil) @@ -102,9 +103,9 @@ :window exwm--root :data (vconcat workareas))) ;; Update _NET_DESKTOP_VIEWPORT (xcb:+request exwm--connection - (make-instance 'xcb:ewmh:set-_NET_DESKTOP_VIEWPORT - :window exwm--root - :data (vconcat viewports))) + (make-instance 'xcb:ewmh:set-_NET_DESKTOP_VIEWPORT + :window exwm--root + :data (vconcat viewports))) (xcb:flush exwm--connection))) (defun exwm-randr--init () @@ -121,11 +122,11 @@ major-version minor-version) (exwm-randr--refresh) (xcb:+event exwm--connection 'xcb:randr:ScreenChangeNotify - (lambda (data synthetic) + (lambda (_data _synthetic) (exwm--log "(RandR) ScreenChangeNotify") (exwm-randr--refresh))) ;; (xcb:+event exwm--connection 'xcb:randr:Notify - ;; (lambda (data synthetic) + ;; (lambda (_data _synthetic) ;; (exwm--log "(RandR) Notify") ;; (exwm-randr--refresh))) (xcb:+request exwm--connection @@ -142,7 +143,7 @@ (defun exwm-randr-enable () "Enable RandR support for EXWM." - (add-hook 'exwm-init-hook 'exwm-randr--init)) + (add-hook 'exwm-init-hook #'exwm-randr--init)) diff --git a/exwm-workspace.el b/exwm-workspace.el index f4e1dd19509f..9cf1ff050900 100644 --- a/exwm-workspace.el +++ b/exwm-workspace.el @@ -1,31 +1,36 @@ ;;; exwm-workspace.el --- Workspace Module for EXWM -*- lexical-binding: t -*- -;; Copyright (C) 2015 Chris Feng +;; Copyright (C) 2015 Free Software Foundation, Inc. ;; Author: Chris Feng <chris.w.feng@gmail.com> -;; Keywords: unix -;; This file is not part of GNU Emacs. +;; This file is part of GNU Emacs. -;; This file is free software: you can redistribute it and/or modify +;; GNU Emacs 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, +;; GNU Emacs 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 <http://www.gnu.org/licenses/>. +;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. ;;; Commentary: ;; This module adds workspace support for EXWM. +;; Todo: +;; + Auto hide minibuffer, or allow users to place it elsewhere. +;; + Add system tray support. + ;;; Code: +(require 'exwm-core) + (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 @@ -42,23 +47,24 @@ (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) + (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) + (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.") +;;;###autoload (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))) @@ -95,14 +101,14 @@ The optional FORCE option is for internal use only." (interactive (list (unless (and (eq major-mode 'exwm-mode) exwm--fullscreen) ;it's invisible - (let* ((history-add-new-input nil) ;prevent modifying history + (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))))) + (cl-position idx exwm-workspace--switch-history :test #'equal))))) (when index (unless (and (<= 0 index) (< index exwm-workspace-number)) (user-error "[EXWM] Workspace index out of range: %d" index)) @@ -150,6 +156,7 @@ The optional FORCE option is for internal use only." (exwm--log "Workspace was switched unexpectedly") (exwm-workspace-switch index)))) +;;;###autoload (defun exwm-workspace-move-window (index &optional id) "Move window ID to workspace INDEX." (interactive @@ -161,7 +168,7 @@ The optional FORCE option is for internal use only." exwm-workspace--switch-map nil `(exwm-workspace--switch-history . ,(1+ exwm-workspace-current-index))))) - (cl-position idx exwm-workspace--switch-history :test 'equal)))) + (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)) @@ -169,9 +176,8 @@ The optional FORCE option is for internal use only." (let ((frame (elt exwm-workspace--list index))) (when (not (equal exwm--frame frame)) (let ((name (replace-regexp-in-string "^\\s-*" "" (buffer-name)))) - (exwm-workspace-rename-buffer (if (= index exwm-workspace-current-index) - name - (concat " " name)))) + (exwm-workspace-rename-buffer + (if (= index exwm-workspace-current-index) name (concat " " name)))) (setq exwm--frame frame) (if exwm--floating-frame ;; Move the floating frame is enough @@ -232,14 +238,14 @@ The optional FORCE option is for internal use only." ;; Prevent user from deleting this frame by accident (set-frame-parameter (car exwm-workspace--list) 'client nil)) ;; Create remaining frames - (dotimes (i (1- exwm-workspace-number)) + (dotimes (_ (1- exwm-workspace-number)) (nconc exwm-workspace--list (list (make-frame '((window-system . x) (visibility . nil)))))) ;; 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)))) + (let ((window-id (string-to-number (frame-parameter i 'window-id))) + (outer-id (string-to-number (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) @@ -263,7 +269,7 @@ The optional FORCE option is for internal use only." (set-frame-parameter i 'fullscreen 'fullboth)) (raise-frame (car exwm-workspace--list)) ;; Handle unexpected frame switch - (add-hook 'focus-in-hook 'exwm-workspace--on-focus-in) + (add-hook 'focus-in-hook #'exwm-workspace--on-focus-in) ;; Set _NET_VIRTUAL_ROOTS (xcb:+request exwm--connection (make-instance 'xcb:ewmh:set-_NET_VIRTUAL_ROOTS diff --git a/exwm.el b/exwm.el index 3b2705a163fc..84fbc1525583 100644 --- a/exwm.el +++ b/exwm.el @@ -1,80 +1,46 @@ ;;; exwm.el --- Emacs X Window Manager -*- lexical-binding: t -*- -;; Copyright (C) 2015 Chris Feng +;; Copyright (C) 2015 Free Software Foundation, Inc. ;; Author: Chris Feng <chris.w.feng@gmail.com> +;; Maintainer: Chris Feng <chris.w.feng@gmail.com> +;; Version: 0 +;; Package-Requires: ((xelb "0.1")) ;; Keywords: unix +;; URL: https://github.com/ch11ng/exwm -;; This file is not part of GNU Emacs. +;; This file is part of GNU Emacs. -;; This file is free software: you can redistribute it and/or modify +;; GNU Emacs 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, +;; GNU Emacs 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 <http://www.gnu.org/licenses/>. +;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. ;;; 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 a tiling window manager, though unfortunately not for -;; managing X things. EXWM has therefore been 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. +;; EXWM (Emacs X Window Manager) is a full-featured tiling X window manager for +;; Emacs built on top of XELB. It features: +;; + Fully keyboard-driven operation +;; + Hybrid layout modes (tiling & stacking) +;; + Workspace support +;; + ICCCM/EWMH compliance +;; + Basic RandR support (optional) ;; 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): +;; 1. Install XELB and EXWM, and make sure they are in `load-path'. +;; 2. In '~/.emacs', add following lines (please modify accordingly): ;; ;; (require 'exwm) ;; ;; We always need a way to go back from char-mode to line-mode @@ -83,51 +49,23 @@ ;; (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))) +;; (lambda () (exwm-workspace-rename-buffer exwm-class-name t))) ;; ;; Enable EXWM ;; (exwm-enable) ;; -;; 3. Make a file '~/.xinitrc' with the content +;; 3. Make a file '~/.xinitrc' with the following lines: ;; +;; # You may need to comment out the next line to disable access control +;; #xhost + ;; exec emacs ;; -;; 4. Launch EXWM in a console with +;; 4. Launch EXWM in a console (e.g. tty1) with ;; -;; xinit +;; xinit -- vt01 ;; -;; 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: -;; + 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. +;; You should additionally hide the menu-bar, tool-bar, etc to increase the +;; usable space. Please check the wiki (https://github.com/ch11ng/exwm/wiki) +;; for more detailed instructions on installation, configuration, usage, etc. ;; References: ;; + dwm (http://dwm.suckless.org/) @@ -136,61 +74,13 @@ ;;; Code: -(require 'xcb) -(require 'xcb-icccm) -(require 'xcb-ewmh) +(require 'exwm-core) (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 (<X window ID> . <Emacs buffer>)") - -(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--make-emacs-idle-for (seconds) - "Put Emacs in idle state for SECONDS seconds." - (with-timeout (seconds) (read-event))) - (defun exwm-reset () "Reset window to standard state: non-fullscreen, line-mode." (interactive) @@ -201,6 +91,7 @@ (exwm-layout--refresh) (exwm-input-grab-keyboard)))) +;;;###autoload (defun exwm--update-window-type (id &optional force) "Update _NET_WM_WINDOW_TYPE." (with-current-buffer (exwm--id->buffer id) @@ -214,6 +105,7 @@ (defvar exwm-update-class-hook nil "Normal hook run when window class is updated.") +;;;###autoload (defun exwm--update-class (id &optional force) "Update WM_CLASS." (with-current-buffer (exwm--id->buffer id) @@ -229,6 +121,7 @@ (defvar exwm-update-title-hook nil "Normal hook run when window title is updated.") +;;;###autoload (defun exwm--update-utf8-title (id &optional force) "Update _NET_WM_NAME." (with-current-buffer (exwm--id->buffer id) @@ -241,6 +134,7 @@ (setq exwm--title-is-utf8 t) (run-hooks 'exwm-update-title-hook))))))) +;;;###autoload (defun exwm--update-ctext-title (id &optional force) "Update WM_NAME." (with-current-buffer (exwm--id->buffer id) @@ -253,11 +147,13 @@ (when exwm-title (run-hooks 'exwm-update-title-hook))))))) +;;;###autoload (defun exwm--update-title (id) "Update _NET_WM_NAME or WM_NAME." (exwm--update-utf8-title id) (exwm--update-ctext-title id)) +;;;###autoload (defun exwm--update-transient-for (id &optional force) "Update WM_TRANSIENT_FOR." (with-current-buffer (exwm--id->buffer id) @@ -268,6 +164,7 @@ (when reply ;nil when destroyed (setq exwm-transient-for (slot-value reply 'value))))))) +;;;###autoload (defun exwm--update-normal-hints (id &optional force) "Update WM_NORMAL_HINTS." (with-current-buffer (exwm--id->buffer id) @@ -315,6 +212,7 @@ (= exwm--normal-hints-min-height exwm--normal-hints-max-height))))))))) +;;;###autoload (defun exwm--update-hints (id &optional force) "Update WM_HINTS." (with-current-buffer (exwm--id->buffer id) @@ -334,6 +232,7 @@ (set-frame-parameter exwm--frame 'exwm--urgency t) (exwm-workspace--update-switch-history)))))))) +;;;###autoload (defun exwm--update-protocols (id &optional force) "Update WM_PROTOCOLS." (with-current-buffer (exwm--id->buffer id) @@ -344,6 +243,7 @@ (when reply ;nil when destroyed (setq exwm--protocols (append (slot-value reply 'value) nil))))))) +;;;###autoload (defun exwm--update-state (id &optional force) "Update WM_STATE." (with-current-buffer (exwm--id->buffer id) @@ -355,16 +255,14 @@ ;; Default to normal state xcb:icccm:WM_STATE:NormalState))))))) -(defun exwm--on-PropertyNotify (data synthetic) +(defun exwm--on-PropertyNotify (data _synthetic) "Handle PropertyNotify event." (let ((obj (make-instance 'xcb:PropertyNotify)) - atom window state - buffer) + atom id 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)) + exwm-input--timestamp (slot-value obj 'time)) (setq buffer (exwm--id->buffer id)) (when (buffer-live-p buffer) (with-current-buffer buffer @@ -391,7 +289,7 @@ (x-get-atom-name atom exwm-workspace--current) atom))))))) -(defun exwm--on-ClientMessage (raw-data synthetic) +(defun exwm--on-ClientMessage (raw-data _synthetic) "Handle ClientMessage event." (let ((obj (make-instance 'xcb:ClientMessage)) type id data) @@ -420,20 +318,20 @@ ;; _NET_REQUEST_FRAME_EXTENTS ((= type xcb:Atom:_NET_REQUEST_FRAME_EXTENTS) (let ((buffer (exwm--id->buffer id)) - left right top bottom) + left right top btm) (if (or (not buffer) (with-current-buffer buffer (not exwm--floating-frame))) - (setq left 0 right 0 top 0 bottom 0) + (setq left 0 right 0 top 0 btm 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)))) + btm (+ 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))) + :top top :bottom btm))) (xcb:flush exwm--connection)) ;; _NET_WM_STATE ((= type xcb:Atom:_NET_WM_STATE) @@ -502,18 +400,18 @@ ((= type xcb:Atom:WM_PROTOCOLS) (let ((type (elt data 0))) (cond ((= type xcb:Atom:_NET_WM_PING) - (setq exwm--ping-lock nil)) + (setq exwm-manage--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) + (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) + (xcb:+event exwm--connection 'xcb:ClientMessage #'exwm--on-ClientMessage) ;; Set _NET_SUPPORTED (xcb:+request exwm--connection (make-instance 'xcb:ewmh:set-_NET_SUPPORTED @@ -580,7 +478,7 @@ ;; Set _NET_WORKAREA (with minibuffer and bottom mode-line excluded) (let* ((workareas (vector 0 0 (x-display-pixel-width) (x-display-pixel-height))) - (workareas (mapconcat (lambda (i) workareas) + (workareas (mapconcat (lambda (_) workareas) (make-list exwm-workspace-number 0) []))) (xcb:+request exwm--connection (make-instance 'xcb:ewmh:set-_NET_WORKAREA @@ -626,84 +524,14 @@ (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 - (set (make-local-variable 'exwm--on-KeyPress) ;KeyPress event handler - 'exwm-input--on-KeyPress-line-mode) - ;; 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" + "Enable/Disable EXWM." (if (eq undo 'undo) - (progn (remove-hook 'window-setup-hook 'exwm-init) - (remove-hook 'after-make-frame-functions 'exwm-init)) - (setq frame-resize-pixelwise t) ;mandatory; before init - (add-hook 'window-setup-hook 'exwm-init t) ;for Emacs - (add-hook 'after-make-frame-functions 'exwm-init t))) ;for Emacs Client + (progn (remove-hook 'window-setup-hook #'exwm-init) + (remove-hook 'after-make-frame-functions #'exwm-init)) + (setq frame-resize-pixelwise t) ;mandatory; before init + (add-hook 'window-setup-hook #'exwm-init t) ;for Emacs + (add-hook 'after-make-frame-functions #'exwm-init t))) ;for Emacs Client (defun exwm--ido-buffer-window-other-frame (orig-fun buffer) "Wrapper for `ido-buffer-window-other-frame' to exclude invisible windows." @@ -717,17 +545,17 @@ (defun exwm--fix-ido-buffer-window-other-frame () "Fix `ido-buffer-window-other-frame'." (advice-add 'ido-buffer-window-other-frame :around - 'exwm--ido-buffer-window-other-frame)) + #'exwm--ido-buffer-window-other-frame)) (defun exwm-enable-ido-workaround () - "Enable workarounds for `ido-mode'." - (add-hook 'exwm-init-hook 'exwm--fix-ido-buffer-window-other-frame)) + "Enable workarounds for 'ido-mode'." + (add-hook 'exwm-init-hook #'exwm--fix-ido-buffer-window-other-frame)) (defun exwm-disable-ido-workaround () - "Disable workarounds for `ido-mode'." - (remove-hook 'exwm-init-hook 'exwm--fix-ido-buffer-window-other-frame) + "Disable workarounds for 'ido-mode'." + (remove-hook 'exwm-init-hook #'exwm--fix-ido-buffer-window-other-frame) (advice-remove 'ido-buffer-window-other-frame - 'exwm--ido-buffer-window-other-frame)) + #'exwm--ido-buffer-window-other-frame)) |