summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDevin J. Pohly <djpohly@gmail.com>2020-04-11 17:27:19 -0500
committerDevin J. Pohly <djpohly@gmail.com>2020-04-11 17:27:19 -0500
commit94d82bf42f998a84f5e46cde0b8a309d59425598 (patch)
tree0b450b414d62cd071c00fb2cde3f4dd0ce2afa61
Start with tinywl
Add a config.h into which configurables can be moved.
-rw-r--r--.gitignore4
-rw-r--r--LICENSE690
-rw-r--r--Makefile30
-rw-r--r--README.md50
-rw-r--r--config.h7
-rw-r--r--dwl.c950
6 files changed, 1731 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..e8ad87c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+dwl
+*-protocol.c
+*-protocol.h
+.ccls-cache
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..da0053e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,690 @@
+dwl - dwm for Wayland
+
+Copyright © 2020 Devin J. Pohly
+
+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.
+
+----
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://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 <https://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
+<https://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
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..818686c
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,30 @@
+WAYLAND_PROTOCOLS=$(shell pkg-config --variable=pkgdatadir wayland-protocols)
+WAYLAND_SCANNER=$(shell pkg-config --variable=wayland_scanner wayland-scanner)
+LIBS=\
+ $(shell pkg-config --cflags --libs wlroots) \
+ $(shell pkg-config --cflags --libs wayland-server) \
+ $(shell pkg-config --cflags --libs xkbcommon)
+
+# wayland-scanner is a tool which generates C headers and rigging for Wayland
+# protocols, which are specified in XML. wlroots requires you to rig these up
+# to your build system yourself and provide them in the include path.
+xdg-shell-protocol.h:
+ $(WAYLAND_SCANNER) server-header \
+ $(WAYLAND_PROTOCOLS)/stable/xdg-shell/xdg-shell.xml $@
+
+xdg-shell-protocol.c: xdg-shell-protocol.h
+ $(WAYLAND_SCANNER) private-code \
+ $(WAYLAND_PROTOCOLS)/stable/xdg-shell/xdg-shell.xml $@
+
+dwl: dwl.c config.h xdg-shell-protocol.h xdg-shell-protocol.c
+ $(CC) $(CFLAGS) \
+ -g -Werror -I. \
+ -DWLR_USE_UNSTABLE \
+ -o $@ $< \
+ $(LIBS)
+
+clean:
+ rm -f dwl xdg-shell-protocol.h xdg-shell-protocol.c
+
+.DEFAULT_GOAL=dwl
+.PHONY: clean
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d76211f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# dwl
+
+This is the "minimum viable product" Wayland compositor based on wlroots. It
+aims to implement a Wayland compositor in the fewest lines of code possible,
+while still supporting a reasonable set of features. Reading this code is the
+best starting point for anyone looking to build their own Wayland compositor
+based on wlroots.
+
+
+## Building dwl
+
+dwl is disconnected from the main wlroots build system, in order to make it
+easier to understand the build requirements for your own Wayland compositors.
+Simply install the dependencies:
+
+- wlroots
+- wayland-protocols
+
+And run `make`.
+
+
+## Running dwl
+
+You can run dwl with `./dwl`. In an existing Wayland or X11 session,
+dwl will open a Wayland or X11 window respectively to act as a virtual
+display. You can then open Wayland windows by setting `WAYLAND_DISPLAY` to the
+value shown in the logs. You can also run `./dwl` from a TTY.
+
+In either case, you will likely want to specify `-s [cmd]` to run a command at
+startup, such as a terminal emulator. This will be necessary to start any new
+programs from within the compositor, as dwl does not support any custom
+keybindings. dwl supports the following keybindings:
+
+- `Alt+Escape`: Terminate the compositor
+- `Alt+F1`: Cycle between windows
+
+
+## Limitations
+
+Notable omissions from dwl:
+
+- HiDPI support
+- Any kind of configuration, e.g. output layout
+- Any protocol other than xdg-shell (e.g. layer-shell, for
+ panels/taskbars/etc; or Xwayland, for proxied X11 windows)
+- Optional protocols, e.g. screen capture, primary selection, virtual
+ keyboard, etc. Most of these are plug-and-play with wlroots, but they're
+ omitted for brevity.
+- Damage tracking, which tracks which parts of the screen are changing and
+ minimizes redraws accordingly.
diff --git a/config.h b/config.h
new file mode 100644
index 0000000..ff05992
--- /dev/null
+++ b/config.h
@@ -0,0 +1,7 @@
+static const struct xkb_rule_names xkb_rules = {
+ .rules = NULL,
+ .model = NULL,
+ .layout = "dvorak",
+ .variant = NULL,
+ .options = NULL,
+};
diff --git a/dwl.c b/dwl.c
new file mode 100644
index 0000000..6738f9d
--- /dev/null
+++ b/dwl.c
@@ -0,0 +1,950 @@
+/*
+ * See LICENSE file for copyright and license details.
+ */
+#define _POSIX_C_SOURCE 200112L
+#include <getopt.h>
+#include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <time.h>
+#include <unistd.h>
+#include <wayland-server-core.h>
+#include <wlr/backend.h>
+#include <wlr/render/wlr_renderer.h>
+#include <wlr/types/wlr_cursor.h>
+#include <wlr/types/wlr_compositor.h>
+#include <wlr/types/wlr_data_device.h>
+#include <wlr/types/wlr_input_device.h>
+#include <wlr/types/wlr_keyboard.h>
+#include <wlr/types/wlr_matrix.h>
+#include <wlr/types/wlr_output.h>
+#include <wlr/types/wlr_output_layout.h>
+#include <wlr/types/wlr_pointer.h>
+#include <wlr/types/wlr_seat.h>
+#include <wlr/types/wlr_xcursor_manager.h>
+#include <wlr/types/wlr_xdg_shell.h>
+#include <wlr/util/log.h>
+#include <xkbcommon/xkbcommon.h>
+
+/* For brevity's sake, struct members are annotated where they are used. */
+enum dwl_cursor_mode {
+ DWL_CURSOR_PASSTHROUGH,
+ DWL_CURSOR_MOVE,
+ DWL_CURSOR_RESIZE,
+};
+
+struct dwl_server {
+ struct wl_display *wl_display;
+ struct wlr_backend *backend;
+ struct wlr_renderer *renderer;
+
+ struct wlr_xdg_shell *xdg_shell;
+ struct wl_listener new_xdg_surface;
+ struct wl_list views;
+
+ struct wlr_cursor *cursor;
+ struct wlr_xcursor_manager *cursor_mgr;
+ struct wl_listener cursor_motion;
+ struct wl_listener cursor_motion_absolute;
+ struct wl_listener cursor_button;
+ struct wl_listener cursor_axis;
+ struct wl_listener cursor_frame;
+
+ struct wlr_seat *seat;
+ struct wl_listener new_input;
+ struct wl_listener request_cursor;
+ struct wl_list keyboards;
+ enum dwl_cursor_mode cursor_mode;
+ struct dwl_view *grabbed_view;
+ double grab_x, grab_y;
+ int grab_width, grab_height;
+ uint32_t resize_edges;
+
+ struct wlr_output_layout *output_layout;
+ struct wl_list outputs;
+ struct wl_listener new_output;
+};
+
+struct dwl_output {
+ struct wl_list link;
+ struct dwl_server *server;
+ struct wlr_output *wlr_output;
+ struct wl_listener frame;
+};
+
+struct dwl_view {
+ struct wl_list link;
+ struct dwl_server *server;
+ struct wlr_xdg_surface *xdg_surface;
+ struct wl_listener map;
+ struct wl_listener unmap;
+ struct wl_listener destroy;
+ struct wl_listener request_move;
+ struct wl_listener request_resize;
+ bool mapped;
+ int x, y;
+};
+
+struct dwl_keyboard {
+ struct wl_list link;
+ struct dwl_server *server;
+ struct wlr_input_device *device;
+
+ struct wl_listener modifiers;
+ struct wl_listener key;
+};
+
+#include "config.h"
+
+static void focus_view(struct dwl_view *view, struct wlr_surface *surface) {
+ /* Note: this function only deals with keyboard focus. */
+ if (view == NULL) {
+ return;
+ }
+ struct dwl_server *server = view->server;
+ struct wlr_seat *seat = server->seat;
+ struct wlr_surface *prev_surface = seat->keyboard_state.focused_surface;
+ if (prev_surface == surface) {
+ /* Don't re-focus an already focused surface. */
+ return;
+ }
+ if (prev_surface) {
+ /*
+ * Deactivate the previously focused surface. This lets the client know
+ * it no longer has focus and the client will repaint accordingly, e.g.
+ * stop displaying a caret.
+ */
+ struct wlr_xdg_surface *previous = wlr_xdg_surface_from_wlr_surface(
+ seat->keyboard_state.focused_surface);
+ wlr_xdg_toplevel_set_activated(previous, false);
+ }
+ struct wlr_keyboard *keyboard = wlr_seat_get_keyboard(seat);
+ /* Move the view to the front */
+ wl_list_remove(&view->link);
+ wl_list_insert(&server->views, &view->link);
+ /* Activate the new surface */
+ wlr_xdg_toplevel_set_activated(view->xdg_surface, true);
+ /*
+ * Tell the seat to have the keyboard enter this surface. wlroots will keep
+ * track of this and automatically send key events to the appropriate
+ * clients without additional work on your part.
+ */
+ wlr_seat_keyboard_notify_enter(seat, view->xdg_surface->surface,
+ keyboard->keycodes, keyboard->num_keycodes, &keyboard->modifiers);
+}
+
+static void keyboard_handle_modifiers(
+ struct wl_listener *listener, void *data) {
+ /* This event is raised when a modifier key, such as shift or alt, is
+ * pressed. We simply communicate this to the client. */
+ struct dwl_keyboard *keyboard =
+ wl_container_of(listener, keyboard, modifiers);
+ /*
+ * A seat can only have one keyboard, but this is a limitation of the
+ * Wayland protocol - not wlroots. We assign all connected keyboards to the
+ * same seat. You can swap out the underlying wlr_keyboard like this and
+ * wlr_seat handles this transparently.
+ */
+ wlr_seat_set_keyboard(keyboard->server->seat, keyboard->device);
+ /* Send modifiers to the client. */
+ wlr_seat_keyboard_notify_modifiers(keyboard->server->seat,
+ &keyboard->device->keyboard->modifiers);
+}
+
+static bool handle_keybinding(struct dwl_server *server, xkb_keysym_t sym) {
+ /*
+ * Here we handle compositor keybindings. This is when the compositor is
+ * processing keys, rather than passing them on to the client for its own
+ * processing.
+ *
+ * This function assumes Alt is held down.
+ */
+ switch (sym) {
+ case XKB_KEY_Escape:
+ wl_display_terminate(server->wl_display);
+ break;
+ case XKB_KEY_F1:
+ /* Cycle to the next view */
+ if (wl_list_length(&server->views) < 2) {
+ break;
+ }
+ struct dwl_view *current_view = wl_container_of(
+ server->views.next, current_view, link);
+ struct dwl_view *next_view = wl_container_of(
+ current_view->link.next, next_view, link);
+ focus_view(next_view, next_view->xdg_surface->surface);
+ /* Move the previous view to the end of the list */
+ wl_list_remove(&current_view->link);
+ wl_list_insert(server->views.prev, &current_view->link);
+ break;
+ default:
+ return false;
+ }
+ return true;
+}
+
+static void keyboard_handle_key(
+ struct wl_listener *listener, void *data) {
+ /* This event is raised when a key is pressed or released. */
+ struct dwl_keyboard *keyboard =
+ wl_container_of(listener, keyboard, key);
+ struct dwl_server *server = keyboard->server;
+ struct wlr_event_keyboard_key *event = data;
+ struct wlr_seat *seat = server->seat;
+
+ /* Translate libinput keycode -> xkbcommon */
+ uint32_t keycode = event->keycode + 8;
+ /* Get a list of keysyms based on the keymap for this keyboard */
+ const xkb_keysym_t *syms;
+ int nsyms = xkb_state_key_get_syms(
+ keyboard->device->keyboard->xkb_state, keycode, &syms);
+
+ bool handled = false;
+ uint32_t modifiers = wlr_keyboard_get_modifiers(keyboard->device->keyboard);
+ if ((modifiers & WLR_MODIFIER_ALT) && event->state == WLR_KEY_PRESSED) {
+ /* If alt is held down and this button was _pressed_, we attempt to
+ * process it as a compositor keybinding. */
+ for (int i = 0; i < nsyms; i++) {
+ handled = handle_keybinding(server, syms[i]);
+ }
+ }
+
+ if (!handled) {
+ /* Otherwise, we pass it along to the client. */
+ wlr_seat_set_keyboard(seat, keyboard->device);
+ wlr_seat_keyboard_notify_key(seat, event->time_msec,
+ event->keycode, event->state);
+ }
+}
+
+static void server_new_keyboard(struct dwl_server *server,
+ struct wlr_input_device *device) {
+ struct dwl_keyboard *keyboard =
+ calloc(1, sizeof(struct dwl_keyboard));
+ keyboard->server = server;
+ keyboard->device = device;
+
+ /* We need to prepare an XKB keymap and assign it to the keyboard. This
+ * assumes the defaults (e.g. layout = "us"). */
+ struct xkb_context *context = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
+ struct xkb_keymap *keymap = xkb_map_new_from_names(context, &xkb_rules,
+ XKB_KEYMAP_COMPILE_NO_FLAGS);
+
+ wlr_keyboard_set_keymap(device->keyboard, keymap);
+ xkb_keymap_unref(keymap);
+ xkb_context_unref(context);
+ wlr_keyboard_set_repeat_info(device->keyboard, 25, 600);
+
+ /* Here we set up listeners for keyboard events. */
+ keyboard->modifiers.notify = keyboard_handle_modifiers;
+ wl_signal_add(&device->keyboard->events.modifiers, &keyboard->modifiers);
+ keyboard->key.notify = keyboard_handle_key;
+ wl_signal_add(&device->keyboard->events.key, &keyboard->key);
+
+ wlr_seat_set_keyboard(server->seat, device);
+
+ /* And add the keyboard to our list of keyboards */
+ wl_list_insert(&server->keyboards, &keyboard->link);
+}
+
+static void server_new_pointer(struct dwl_server *server,
+ struct wlr_input_device *device) {
+ /* We don't do anything special with pointers. All of our pointer handling
+ * is proxied through wlr_cursor. On another compositor, you might take this
+ * opportunity to do libinput configuration on the device to set
+ * acceleration, etc. */
+ wlr_cursor_attach_input_device(server->cursor, device);
+}
+
+static void server_new_input(struct wl_listener *listener, void *data) {
+ /* This event is raised by the backend when a new input device becomes
+ * available. */
+ struct dwl_server *server =
+ wl_container_of(listener, server, new_input);
+ struct wlr_input_device *device = data;
+ switch (device->type) {
+ case WLR_INPUT_DEVICE_KEYBOARD:
+ server_new_keyboard(server, device);
+ break;
+ case WLR_INPUT_DEVICE_POINTER:
+ server_new_pointer(server, device);
+ break;
+ default:
+ break;
+ }
+ /* We need to let the wlr_seat know what our capabilities are, which is
+ * communiciated to the client. In dwl we always have a cursor, even if
+ * there are no pointer devices, so we always include that capability. */
+ uint32_t caps = WL_SEAT_CAPABILITY_POINTER;
+ if (!wl_list_empty(&server->keyboards)) {
+ caps |= WL_SEAT_CAPABILITY_KEYBOARD;
+ }
+ wlr_seat_set_capabilities(server->seat, caps);
+}
+
+static void seat_request_cursor(struct wl_listener *listener, void *data) {
+ struct dwl_server *server = wl_container_of(
+ listener, server, request_cursor);
+ /* This event is rasied by the seat when a client provides a cursor image */
+ struct wlr_seat_pointer_request_set_cursor_event *event = data;
+ struct wlr_seat_client *focused_client =
+ server->seat->pointer_state.focused_client;
+ /* This can be sent by any client, so we check to make sure this one is
+ * actually has pointer focus first. */
+ if (focused_client == event->seat_client) {
+ /* Once we've vetted the client, we can tell the cursor to use the
+ * provided surface as the cursor image. It will set the hardware cursor
+ * on the output that it's currently on and continue to do so as the
+ * cursor moves between outputs. */
+ wlr_cursor_set_surface(server->cursor, event->surface,
+ event->hotspot_x, event->hotspot_y);
+ }
+}
+
+static bool view_at(struct dwl_view *view,
+ double lx, double ly, struct wlr_surface **surface,
+ double *sx, double *sy) {
+ /*
+ * XDG toplevels may have nested surfaces, such as popup windows for context
+ * menus or tooltips. This function tests if any of those are underneath the
+ * coordinates lx and ly (in output Layout Coordinates). If so, it sets the
+ * surface pointer to that wlr_surface and the sx and sy coordinates to the
+ * coordinates relative to that surface's top-left corner.
+ */
+ double view_sx = lx - view->x;
+ double view_sy = ly - view->y;
+
+ struct wlr_surface_state *state = &view->xdg_surface->surface->current;
+
+ double _sx, _sy;
+ struct wlr_surface *_surface = NULL;
+ _surface = wlr_xdg_surface_surface_at(
+ view->xdg_surface, view_sx, view_sy, &_sx, &_sy);
+
+ if (_surface != NULL) {
+ *sx = _sx;
+ *sy = _sy;
+ *surface = _surface;
+ return true;
+ }
+
+ return false;
+}
+
+static struct dwl_view *desktop_view_at(
+ struct dwl_server *server, double lx, double ly,
+ struct wlr_surface **surface, double *sx, double *sy) {
+ /* This iterates over all of our surfaces and attempts to find one under the
+ * cursor. This relies on server->views being ordered from top-to-bottom. */
+ struct dwl_view *view;
+ wl_list_for_each(view, &server->views, link) {
+ if (view_at(view, lx, ly, surface, sx, sy)) {
+ return view;
+ }
+ }
+ return NULL;
+}
+
+static void process_cursor_move(struct dwl_server *server, uint32_t time) {
+ /* Move the grabbed view to the new position. */
+ server->grabbed_view->x = server->cursor->x - server->grab_x;
+ server->grabbed_view->y = server->cursor->y - server->grab_y;
+}
+
+static void process_cursor_resize(struct dwl_server *server, uint32_t time) {
+ /*
+ * Resizing the grabbed view can be a little bit complicated, because we
+ * could be resizing from any corner or edge. This not only resizes the view
+ * on one or two axes, but can also move the view if you resize from the top
+ * or left edges (or top-left corner).
+ *
+ * Note that I took some shortcuts here. In a more fleshed-out compositor,
+ * you'd wait for the client to prepare a buffer at the new size, then
+ * commit any movement that was prepared.
+ */
+ struct dwl_view *view = server->grabbed_view;
+ double dx = server->cursor->x - server->grab_x;
+ double dy = server->cursor->y - server->grab_y;
+ double x = view->x;
+ double y = view->y;
+ int width = server->grab_width;
+ int height = server->grab_height;
+ if (server->resize_edges & WLR_EDGE_TOP) {
+ y = server->grab_y + dy;
+ height -= dy;
+ if (height < 1) {
+ y += height;
+ }
+ } else if (server->resize_edges & WLR_EDGE_BOTTOM) {
+ height += dy;
+ }
+ if (server->resize_edges & WLR_EDGE_LEFT) {
+ x = server->grab_x + dx;
+ width -= dx;
+ if (width < 1) {
+ x += width;
+ }
+ } else if (server->resize_edges & WLR_EDGE_RIGHT) {
+ width += dx;
+ }
+ view->x = x;
+ view->y = y;
+ wlr_xdg_toplevel_set_size(view->xdg_surface, width, height);
+}
+
+static void process_cursor_motion(struct dwl_server *server, uint32_t time) {
+ /* If the mode is non-passthrough, delegate to those functions. */
+ if (server->cursor_mode == DWL_CURSOR_MOVE) {
+ process_cursor_move(server, time);
+ return;
+ } else if (server->cursor_mode == DWL_CURSOR_RESIZE) {
+ process_cursor_resize(server, time);
+ return;
+ }
+
+ /* Otherwise, find the view under the pointer and send the event along. */
+ double sx, sy;
+ struct wlr_seat *seat = server->seat;
+ struct wlr_surface *surface = NULL;
+ struct dwl_view *view = desktop_view_at(server,
+ server->cursor->x, server->cursor->y, &surface, &sx, &sy);
+ if (!view) {
+ /* If there's no view under the cursor, set the cursor image to a
+ * default. This is what makes the cursor image appear when you move it
+ * around the screen, not over any views. */
+ wlr_xcursor_manager_set_cursor_image(
+ server->cursor_mgr, "left_ptr", server->cursor);
+ }
+ if (surface) {
+ bool focus_changed = seat->pointer_state.focused_surface != surface;
+ /*
+ * "Enter" the surface if necessary. This lets the client know that the
+ * cursor has entered one of its surfaces.
+ *
+ * Note that this gives the surface "pointer focus", which is distinct
+ * from keyboard focus. You get pointer focus by moving the pointer over
+ * a window.
+ */
+ wlr_seat_pointer_notify_enter(seat, surface, sx, sy);
+ if (!focus_changed) {
+ /* The enter event contains coordinates, so we only need to notify
+ * on motion if the focus did not change. */
+ wlr_seat_pointer_notify_motion(seat, time, sx, sy);
+ }
+ } else {
+ /* Clear pointer focus so future button events and such are not sent to
+ * the last client to have the cursor over it. */
+ wlr_seat_pointer_clear_focus(seat);
+ }
+}
+
+static void server_cursor_motion(struct wl_listener *listener, void *data) {
+ /* This event is forwarded by the cursor when a pointer emits a _relative_
+ * pointer motion event (i.e. a delta) */
+ struct dwl_server *server =
+ wl_container_of(listener, server, cursor_motion);
+ struct wlr_event_pointer_motion *event = data;
+ /* The cursor doesn't move unless we tell it to. The cursor automatically
+ * handles constraining the motion to the output layout, as well as any
+ * special configuration applied for the specific input device which
+ * generated the event. You can pass NULL for the device if you want to move
+ * the cursor around without any input. */
+ wlr_cursor_move(server->cursor, event->device,
+ event->delta_x, event->delta_y);
+ process_cursor_motion(server, event->time_msec);
+}
+
+static void server_cursor_motion_absolute(
+ struct wl_listener *listener, void *data) {
+ /* This event is forwarded by the cursor when a pointer emits an _absolute_
+ * motion event, from 0..1 on each axis. This happens, for example, when
+ * wlroots is running under a Wayland window rather than KMS+DRM, and you
+ * move the mouse over the window. You could enter the window from any edge,
+ * so we have to warp the mouse there. There is also some hardware which
+ * emits these events. */
+ struct dwl_server *server =
+ wl_container_of(listener, server, cursor_motion_absolute);
+ struct wlr_event_pointer_motion_absolute *event = data;
+ wlr_cursor_warp_absolute(server->cursor, event->device, event->x, event->y);
+ process_cursor_motion(server, event->time_msec);
+}
+
+static void server_cursor_button(struct wl_listener *listener, void *data) {
+ /* This event is forwarded by the cursor when a pointer emits a button
+ * event. */
+ struct dwl_server *server =
+ wl_container_of(listener, server, cursor_button);
+ struct wlr_event_pointer_button *event = data;
+ /* Notify the client with pointer focus that a button press has occurred */
+ wlr_seat_pointer_notify_button(server->seat,
+ event->time_msec, event->button, event->state);
+ double sx, sy;
+ struct wlr_seat *seat = server->seat;
+ struct wlr_surface *surface;
+ struct dwl_view *view = desktop_view_at(server,
+ server->cursor->x, server->cursor->y, &surface, &sx, &sy);
+ if (event->state == WLR_BUTTON_RELEASED) {
+ /* If you released any buttons, we exit interactive move/resize mode. */
+ server->cursor_mode = DWL_CURSOR_PASSTHROUGH;
+ } else {
+ /* Focus that client if the button was _pressed_ */
+ focus_view(view, surface);
+ }
+}
+
+static void server_cursor_axis(struct wl_listener *listener, void *data) {
+ /* This event is forwarded by the cursor when a pointer emits an axis event,
+ * for example when you move the scroll wheel. */
+ struct dwl_server *server =
+ wl_container_of(listener, server, cursor_axis);
+ struct wlr_event_pointer_axis *event = data;
+ /* Notify the client with pointer focus of the axis event. */
+ wlr_seat_pointer_notify_axis(server->seat,
+ event->time_msec, event->orientation, event->delta,
+ event->delta_discrete, event->source);
+}
+
+static void server_cursor_frame(struct wl_listener *listener, void *data) {
+ /* This event is forwarded by the cursor when a pointer emits an frame
+ * event. Frame events are sent after regular pointer events to group
+ * multiple events together. For instance, two axis events may happen at the
+ * same time, in which case a frame event won't be sent in between. */
+ struct dwl_server *server =
+ wl_container_of(listener, server, cursor_frame);
+ /* Notify the client with pointer focus of the frame event. */
+ wlr_seat_pointer_notify_frame(server->seat);
+}
+
+/* Used to move all of the data necessary to render a surface from the top-level
+ * frame handler to the per-surface render function. */
+struct render_data {
+ struct wlr_output *output;
+ struct wlr_renderer *renderer;
+ struct dwl_view *view;
+ struct timespec *when;
+};
+
+static void render_surface(struct wlr_surface *surface,
+ int sx, int sy, void *data) {
+ /* This function is called for every surface that needs to be rendered. */
+ struct render_data *rdata = data;
+ struct dwl_view *view = rdata->view;
+ struct wlr_output *output = rdata->output;
+
+ /* We first obtain a wlr_texture, which is a GPU resource. wlroots
+ * automatically handles negotiating these with the client. The underlying
+ * resource could be an opaque handle passed from the client, or the client
+ * could have sent a pixel buffer which we copied to the GPU, or a few other
+ * means. You don't have to worry about this, wlroots takes care of it. */
+ struct wlr_texture *texture = wlr_surface_get_texture(surface);
+ if (texture == NULL) {
+ return;
+ }
+
+ /* The view has a position in layout coordinates. If you have two displays,
+ * one next to the other, both 1080p, a view on the rightmost display might
+ * have layout coordinates of 2000,100. We need to translate that to
+ * output-local coordinates, or (2000 - 1920). */
+ double ox = 0, oy = 0;
+ wlr_output_layout_output_coords(
+ view->server->output_layout, output, &ox, &oy);
+ ox += view->x + sx, oy += view->y + sy;
+
+ /* We also have to apply the scale factor for HiDPI outputs. This is only
+ * part of the puzzle, dwl does not fully support HiDPI. */
+ struct wlr_box box = {
+ .x = ox * output->scale,
+ .y = oy * output->scale,
+ .width = surface->current.width * output->scale,
+ .height = surface->current.height * output->scale,
+ };
+
+ /*
+ * Those familiar with OpenGL are also familiar with the role of matricies
+ * in graphics programming. We need to prepare a matrix to render the view
+ * with. wlr_matrix_project_box is a helper which takes a box with a desired
+ * x, y coordinates, width and height, and an output geometry, then
+ * prepares an orthographic projection and multiplies the necessary
+ * transforms to produce a model-view-projection matrix.
+ *
+ * Naturally you can do this any way you like, for example to make a 3D
+ * compositor.
+ */
+ float matrix[9];
+ enum wl_output_transform transform =
+ wlr_output_transform_invert(surface->current.transform);
+ wlr_matrix_project_box(matrix, &box, transform, 0,
+ output->transform_matrix);
+
+ /* This takes our matrix, the texture, and an alpha, and performs the actual
+ * rendering on the GPU. */
+ wlr_render_texture_with_matrix(rdata->renderer, texture, matrix, 1);
+
+ /* This lets the client know that we've displayed that frame and it can
+ * prepare another one now if it likes. */
+ wlr_surface_send_frame_done(surface, rdata->when);
+}
+
+static void output_frame(struct wl_listener *listener, void *data) {
+ /* This function is called every time an output is ready to display a frame,
+ * generally at the output's refresh rate (e.g. 60Hz). */
+ struct dwl_output *output =
+ wl_container_of(listener, output, frame);
+ struct wlr_renderer *renderer = output->server->renderer;
+
+ struct timespec now;
+ clock_gettime(CLOCK_MONOTONIC, &now);
+
+ /* wlr_output_attach_render makes the OpenGL context current. */
+ if (!wlr_output_attach_render(output->wlr_output, NULL)) {
+ return;
+ }
+ /* The "effective" resolution can change if you rotate your outputs. */
+ int width, height;
+ wlr_output_effective_resolution(output->wlr_output, &width, &height);
+ /* Begin the renderer (calls glViewport and some other GL sanity checks) */
+ wlr_renderer_begin(renderer, width, height);
+
+ float color[4] = {0.3, 0.3, 0.3, 1.0};
+ wlr_renderer_clear(renderer, color);
+
+ /* Each subsequent window we render is rendered on top of the last. Because
+ * our view list is ordered front-to-back, we iterate over it backwards. */
+ struct dwl_view *view;
+ wl_list_for_each_reverse(view, &output->server->views, link) {
+ if (!view->mapped) {
+ /* An unmapped view should not be rendered. */
+ continue;
+ }
+ struct render_data rdata = {
+ .output = output->wlr_output,
+ .view = view,
+ .renderer = renderer,
+ .when = &now,
+ };
+ /* This calls our render_surface function for each surface among the
+ * xdg_surface's toplevel and popups. */
+ wlr_xdg_surface_for_each_surface(view->xdg_surface,
+ render_surface, &rdata);
+ }
+
+ /* Hardware cursors are rendered by the GPU on a separate plane, and can be
+ * moved around without re-rendering what's beneath them - which is more
+ * efficient. However, not all hardware supports hardware cursors. For this
+ * reason, wlroots provides a software fallback, which we ask it to render
+ * here. wlr_cursor handles configuring hardware vs software cursors for you,
+ * and this function is a no-op when hardware cursors are in use. */
+ wlr_output_render_software_cursors(output->wlr_output, NULL);
+
+ /* Conclude rendering and swap the buffers, showing the final frame
+ * on-screen. */
+ wlr_renderer_end(renderer);
+ wlr_output_commit(output->wlr_output);
+}
+
+static void server_new_output(struct wl_listener *listener, void *data) {
+ /* This event is rasied by the backend when a new output (aka a display or
+ * monitor) becomes available. */
+ struct dwl_server *server =
+ wl_container_of(listener, server, new_output);
+ struct wlr_output *wlr_output = data;
+
+ /* Some backends don't have modes. DRM+KMS does, and we need to set a mode
+ * before we can use the output. The mode is a tuple of (width, height,
+ * refresh rate), and each monitor supports only a specific set of modes. We
+ * just pick the monitor's preferred mode, a more sophisticated compositor
+ * would let the user configure it. */
+ if (!wl_list_empty(&wlr_output->modes)) {
+ struct wlr_output_mode *mode = wlr_output_preferred_mode(wlr_output);
+ wlr_output_set_mode(wlr_output, mode);
+ wlr_output_enable(wlr_output, true);
+ if (!wlr_output_commit(wlr_output)) {
+ return;
+ }
+ }
+
+ /* Allocates and configures our state for this output */
+ struct dwl_output *output =
+ calloc(1, sizeof(struct dwl_output));
+ output->wlr_output = wlr_output;
+ output->server = server;
+ /* Sets up a listener for the frame notify event. */
+ output->frame.notify = output_frame;
+ wl_signal_add(&wlr_output->events.frame, &output->frame);
+ wl_list_insert(&server->outputs, &output->link);
+
+ /* Adds this to the output layout. The add_auto function arranges outputs
+ * from left-to-right in the order they appear. A more sophisticated
+ * compositor would let the user configure the arrangement of outputs in the
+ * layout. */
+ wlr_output_layout_add_auto(server->output_layout, wlr_output);
+
+ /* Creating the global adds a wl_output global to the display, which Wayland
+ * clients can see to find out information about the output (such as
+ * DPI, scale factor, manufacturer, etc). */
+ wlr_output_create_global(wlr_output);
+}
+
+static void xdg_surface_map(struct wl_listener *listener, void *data) {
+ /* Called when the surface is mapped, or ready to display on-screen. */
+ struct dwl_view *view = wl_container_of(listener, view, map);
+ view->mapped = true;
+ focus_view(view, view->xdg_surface->surface);
+}
+
+static void xdg_surface_unmap(struct wl_listener *listener, void *data) {
+ /* Called when the surface is unmapped, and should no longer be shown. */
+ struct dwl_view *view = wl_container_of(listener, view, unmap);
+ view->mapped = false;
+}
+
+static void xdg_surface_destroy(struct wl_listener *listener, void *data) {
+ /* Called when the surface is destroyed and should never be shown again. */
+ struct dwl_view *view = wl_container_of(listener, view, destroy);
+ wl_list_remove(&view->link);
+ free(view);
+}
+
+static void begin_interactive(struct dwl_view *view,
+ enum dwl_cursor_mode mode, uint32_t edges) {
+ /* This function sets up an interactive move or resize operation, where the
+ * compositor stops propegating pointer events to clients and instead
+ * consumes them itself, to move or resize windows. */
+ struct dwl_server *server = view->server;
+ struct wlr_surface *focused_surface =
+ server->seat->pointer_state.focused_surface;
+ if (view->xdg_surface->surface != focused_surface) {
+ /* Deny move/resize requests from unfocused clients. */
+ return;
+ }
+ server->grabbed_view = view;
+ server->cursor_mode = mode;
+ struct wlr_box geo_box;
+ wlr_xdg_surface_get_geometry(view->xdg_surface, &geo_box);
+ if (mode == DWL_CURSOR_MOVE) {
+ server->grab_x = server->cursor->x - view->x;
+ server->grab_y = server->cursor->y - view->y;
+ } else {
+ server->grab_x = server->cursor->x + geo_box.x;
+ server->grab_y = server->cursor->y + geo_box.y;
+ }
+ server->grab_width = geo_box.width;
+ server->grab_height = geo_box.height;
+ server->resize_edges = edges;
+}
+
+static void xdg_toplevel_request_move(
+ struct wl_listener *listener, void *data) {
+ /* This event is raised when a client would like to begin an interactive
+ * move, typically because the user clicked on their client-side
+ * decorations. Note that a more sophisticated compositor should check the
+ * provied serial against a list of button press serials sent to this
+ * client, to prevent the client from requesting this whenever they want. */
+ struct dwl_view *view = wl_container_of(listener, view, request_move);
+ begin_interactive(view, DWL_CURSOR_MOVE, 0);
+}
+
+static void xdg_toplevel_request_resize(
+ struct wl_listener *listener, void *data) {
+ /* This event is raised when a client would like to begin an interactive
+ * resize, typically because the user clicked on their client-side
+ * decorations. Note that a more sophisticated compositor should check the
+ * provied serial against a list of button press serials sent to this
+ * client, to prevent the client from requesting this whenever they want. */
+ struct wlr_xdg_toplevel_resize_event *event = data;
+ struct dwl_view *view = wl_container_of(listener, view, request_resize);
+ begin_interactive(view, DWL_CURSOR_RESIZE, event->edges);
+}
+
+static void server_new_xdg_surface(struct wl_listener *listener, void *data) {
+ /* This event is raised when wlr_xdg_shell receives a new xdg surface from a
+ * client, either a toplevel (application window) or popup. */
+ struct dwl_server *server =
+ wl_container_of(listener, server, new_xdg_surface);
+ struct wlr_xdg_surface *xdg_surface = data;
+ if (xdg_surface->role != WLR_XDG_SURFACE_ROLE_TOPLEVEL) {
+ return;
+ }
+
+ /* Allocate a dwl_view for this surface */
+ struct dwl_view *view =
+ calloc(1, sizeof(struct dwl_view));
+ view->server = server;
+ view->xdg_surface = xdg_surface;
+
+ /* Listen to the various events it can emit */
+ view->map.notify = xdg_surface_map;
+ wl_signal_add(&xdg_surface->events.map, &view->map);
+ view->unmap.notify = xdg_surface_unmap;
+ wl_signal_add(&xdg_surface->events.unmap, &view->unmap);
+ view->destroy.notify = xdg_surface_destroy;
+ wl_signal_add(&xdg_surface->events.destroy, &view->destroy);
+
+ /* cotd */
+ struct wlr_xdg_toplevel *toplevel = xdg_surface->toplevel;
+ view->request_move.notify = xdg_toplevel_request_move;
+ wl_signal_add(&toplevel->events.request_move, &view->request_move);
+ view->request_resize.notify = xdg_toplevel_request_resize;
+ wl_signal_add(&toplevel->events.request_resize, &view->request_resize);
+
+ /* Add it to the list of views. */
+ wl_list_insert(&server->views, &view->link);
+}
+
+int main(int argc, char *argv[]) {
+ wlr_log_init(WLR_DEBUG, NULL);
+ char *startup_cmd = NULL;
+
+ int c;
+ while ((c = getopt(argc, argv, "s:h")) != -1) {
+ switch (c) {
+ case 's':
+ startup_cmd = optarg;
+ break;
+ default:
+ printf("Usage: %s [-s startup command]\n", argv[0]);
+ return 0;
+ }
+ }
+ if (optind < argc) {
+ printf("Usage: %s [-s startup command]\n", argv[0]);
+ return 0;
+ }
+
+ struct dwl_server server;
+ /* The Wayland display is managed by libwayland. It handles accepting
+ * clients from the Unix socket, manging Wayland globals, and so on. */
+ server.wl_display = wl_display_create();
+ /* The backend is a wlroots feature which abstracts the underlying input and
+ * output hardware. The autocreate option will choose the most suitable
+ * backend based on the current environment, such as opening an X11 window
+ * if an X11 server is running. The NULL argument here optionally allows you
+ * to pass in a custom renderer if wlr_renderer doesn't meet your needs. The
+ * backend uses the renderer, for example, to fall back to software cursors
+ * if the backend does not support hardware cursors (some older GPUs
+ * don't). */
+ server.backend = wlr_backend_autocreate(server.wl_display, NULL);
+
+ /* If we don't provide a renderer, autocreate makes a GLES2 renderer for us.
+ * The renderer is responsible for defining the various pixel formats it
+ * supports for shared memory, this configures that for clients. */
+ server.renderer = wlr_backend_get_renderer(server.backend);
+ wlr_renderer_init_wl_display(server.renderer, server.wl_display);
+
+ /* This creates some hands-off wlroots interfaces. The compositor is
+ * necessary for clients to allocate surfaces and the data device manager
+ * handles the clipboard. Each of these wlroots interfaces has room for you
+ * to dig your fingers in and play with their behavior if you want. */
+ wlr_compositor_create(server.wl_display, server.renderer);
+ wlr_data_device_manager_create(server.wl_display);
+
+ /* Creates an output layout, which a wlroots utility for working with an
+ * arrangement of screens in a physical layout. */
+ server.output_layout = wlr_output_layout_create();
+
+ /* Configure a listener to be notified when new outputs are available on the
+ * backend. */
+ wl_list_init(&server.outputs);
+ server.new_output.notify = server_new_output;
+ wl_signal_add(&server.backend->events.new_output, &server.new_output);
+
+ /* Set up our list of views and the xdg-shell. The xdg-shell is a Wayland
+ * protocol which is used for application windows. For more detail on
+ * shells, refer to my article:
+ *
+ * https://drewdevault.com/2018/07/29/Wayland-shells.html
+ */
+ wl_list_init(&server.views);
+ server.xdg_shell = wlr_xdg_shell_create(server.wl_display);
+ server.new_xdg_surface.notify = server_new_xdg_surface;
+ wl_signal_add(&server.xdg_shell->events.new_surface,
+ &server.new_xdg_surface);
+
+ /*
+ * Creates a cursor, which is a wlroots utility for tracking the cursor
+ * image shown on screen.
+ */
+ server.cursor = wlr_cursor_create();
+ wlr_cursor_attach_output_layout(server.cursor, server.output_layout);
+
+ /* Creates an xcursor manager, another wlroots utility which loads up
+ * Xcursor themes to source cursor images from and makes sure that cursor
+ * images are available at all scale factors on the screen (necessary for
+ * HiDPI support). We add a cursor theme at scale factor 1 to begin with. */
+ server.cursor_mgr = wlr_xcursor_manager_create(NULL, 24);
+ wlr_xcursor_manager_load(server.cursor_mgr, 1);
+
+ /*
+ * wlr_cursor *only* displays an image on screen. It does not move around
+ * when the pointer moves. However, we can attach input devices to it, and
+ * it will generate aggregate events for all of them. In these events, we
+ * can choose how we want to process them, forwarding them to clients and
+ * moving the cursor around. More detail on this process is described in my
+ * input handling blog post:
+ *
+ * https://drewdevault.com/2018/07/17/Input-handling-in-wlroots.html
+ *
+ * And more comments are sprinkled throughout the notify functions above.
+ */
+ server.cursor_motion.notify = server_cursor_motion;
+ wl_signal_add(&server.cursor->events.motion, &server.cursor_motion);
+ server.cursor_motion_absolute.notify = server_cursor_motion_absolute;
+ wl_signal_add(&server.cursor->events.motion_absolute,
+ &server.cursor_motion_absolute);
+ server.cursor_button.notify = server_cursor_button;
+ wl_signal_add(&server.cursor->events.button, &server.cursor_button);
+ server.cursor_axis.notify = server_cursor_axis;
+ wl_signal_add(&server.cursor->events.axis, &server.cursor_axis);
+ server.cursor_frame.notify = server_cursor_frame;
+ wl_signal_add(&server.cursor->events.frame, &server.cursor_frame);
+
+ /*
+ * Configures a seat, which is a single "seat" at which a user sits and
+ * operates the computer. This conceptually includes up to one keyboard,
+ * pointer, touch, and drawing tablet device. We also rig up a listener to
+ * let us know when new input devices are available on the backend.
+ */
+ wl_list_init(&server.keyboards);
+ server.new_input.notify = server_new_input;
+ wl_signal_add(&server.backend->events.new_input, &server.new_input);
+ server.seat = wlr_seat_create(server.wl_display, "seat0");
+ server.request_cursor.notify = seat_request_cursor;
+ wl_signal_add(&server.seat->events.request_set_cursor,
+ &server.request_cursor);
+
+ /* Add a Unix socket to the Wayland display. */
+ const char *socket = wl_display_add_socket_auto(server.wl_display);
+ if (!socket) {
+ wlr_backend_destroy(server.backend);
+ return 1;
+ }
+
+ /* Start the backend. This will enumerate outputs and inputs, become the DRM
+ * master, etc */
+ if (!wlr_backend_start(server.backend)) {
+ wlr_backend_destroy(server.backend);
+ wl_display_destroy(server.wl_display);
+ return 1;
+ }
+
+ /* Set the WAYLAND_DISPLAY environment variable to our socket and run the
+ * startup command if requested. */
+ setenv("WAYLAND_DISPLAY", socket, true);
+ if (startup_cmd) {
+ if (fork() == 0) {
+ execl("/bin/sh", "/bin/sh", "-c", startup_cmd, (void *)NULL);
+ }
+ }
+ /* Run the Wayland event loop. This does not return until you exit the
+ * compositor. Starting the backend rigged up all of the necessary event
+ * loop configuration to listen to libinput events, DRM events, generate
+ * frame events at the refresh rate, and so on. */
+ wlr_log(WLR_INFO, "Running Wayland compositor on WAYLAND_DISPLAY=%s",
+ socket);
+ wl_display_run(server.wl_display);
+
+ /* Once wl_display_run returns, we shut down the server. */
+ wl_display_destroy_clients(server.wl_display);
+ wl_display_destroy(server.wl_display);
+ return 0;
+}