Init

.clang-format

@@ -0,0 +1,107 @@
+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: All
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: false
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     80
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 2
+ContinuationIndentWidth: 2
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+  - Regex:           '.*'
+    Priority:        1
+IncludeIsMainRegex: '(Test)?$'
+IndentCaseLabels: false
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+TabWidth:        2
+UseTab:          ForIndentation
+...

.gitignore

@@ -0,0 +1,8 @@
+*~
+*\#*
+*.o
+*-client-protocol.h
+include/config.h
+.gdb_history
+*.log
+wvkbd

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "wld"]
+	path = wld
+	url = https://github.com/michaelforney/wld.git

COPYING

@@ -0,0 +1,10 @@
+Copyright © 2020 John Sullivan <jsullivan@csumb.edu>
+
+os-compatibility.h and os-compatibility.c are licensed by the Wayland project
+under the MIT/X license. See more details in COPYING_WESTON.
+
+wld submodule is licensed by Michael Forney under the MIT license, see COPYING
+in `wld/`.
+
+All other code in this repository falls under the terms of the GPL v3.0 license,
+which can be found in LICENSE.

COPYING_WESTON

@@ -0,0 +1,30 @@
+Copyright © 2008-2012 Kristian Høgsberg
+Copyright © 2010-2012 Intel Corporation
+Copyright © 2010-2011 Benjamin Franzke
+Copyright © 2011-2012 Collabora, Ltd.
+Copyright © 2010 Red Hat <mjg@redhat.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+---
+
+The above is the version of the MIT "Expat" License used by X.org:
+
+    http://cgit.freedesktop.org/xorg/xserver/tree/COPYING

LICENSE

@@ -0,0 +1,674 @@
+                    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>.

Makefile

@@ -0,0 +1,46 @@
+include config.mk
+
+SRC=.
+WLDSRC=wld
+
+PKGS = fontconfig wayland-client xkbcommon pixman-1
+
+WVKBD_SOURCES += $(wildcard $(SRC)/*.c)
+WVKBD_HEADERS += $(wildcard $(SRC)/*.h)
+
+CFLAGS += -std=gnu99 -Wall -g -DWITH_WAYLAND_SHM
+CFLAGS += $(shell pkg-config --cflags $(PKGS))
+LDFLAGS =wld/libwld.a $(shell pkg-config --libs $(PKGS)) -lm -lutil
+
+WAYLAND_HEADERS = $(wildcard proto/*.xml)
+
+HDRS = $(WAYLAND_HEADERS:.xml=-client-protocol.h)
+WAYLAND_SRC = $(HDRS:.h=.c)
+SOURCES = $(WVKBD_SOURCES) $(WAYLAND_SRC)
+
+OBJECTS = $(SOURCES:.c=.o)
+
+all: wld wvkbd
+
+proto/%-client-protocol.c: proto/%.xml
+	wayland-scanner code < $? > $@
+
+proto/%-client-protocol.h: proto/%.xml
+	wayland-scanner client-header < $? > $@
+
+$(OBJECTS): $(HDRS) $(WVKBD_HEADERS)
+
+wvkbd: $(OBJECTS)
+	$(CC) -o wvkbd $(OBJECTS) $(LDFLAGS)
+
+wld: wld/libwld.a
+
+wld/libwld.a:
+	$(MAKE) -C wld ENABLE_DRM=0
+
+clean:
+	rm -f $(OBJECTS) $(HDRS) $(WAYLAND_SRC) wvkbd
+	$(MAKE) -C wld clean
+
+format:
+	clang-format -i $(WVKBD_SOURCES) $(WVKBD_HEADERS)

README.md

@@ -0,0 +1,62 @@
+# wvkbd - On-screen keyboard for wlroots that sucks less
+
+<img src="https://raw.githubusercontent.com/jjsullivan5196/wvkbd/master/contrib/grab.png" width=350 />
+
+This project aims to deliver a minimum implementation of a wlroots on-screen
+keyboard in legible C. This will **only** be a keyboard, not a feedback buzzer,
+led blinker, or anything that requires more than what's needed to input text
+quickly. The end product should be a static codebase that can be patched to add
+new features.
+
+At the moment work still needs to be done to make the keyboard fully functional
+and determine a minimum feature set. As of now, the following works:
+
+## Features
+
+ - Typing, modifier locking, layout switching
+ - Positive visual feedback on key presses
+ - Custom layouts
+ - Custom color schemes
+
+There are some relatively critical areas that still need work:
+
+ - Proper drawing of font glyphs/fontconfig alternatives (unknown glyphs for the
+   configured font are not drawn)
+ - Make sure the virtual input method in wayland is working as best as it can
+ - Customize keyboard window docking
+ - Nicer layout drawing/padding
+ - Determine if some dependencies are really needed (fontconfig is VERY
+   annoying, and wld may not be strictly necessary)
+
+And some nice to haves:
+
+ - Daemon mode (hide/show keyboard on signals)
+ - Support for input method protocol in wayland, ability to respond to text
+   fields
+ - Alt input modes for things like emojis
+ - Typical international layouts in the repository
+
+Of course there's probably some more I'm forgetting, everything here is very
+much early WIP so things will change very quickly.
+
+## Install
+
+You'll need the following developer packages
+
+ - fontconfig
+ - wayland-client
+ - xkbcommon
+ - pixman
+
+After cloning this repo, run `git submodules update --init --recursive`
+
+Make any customizations you would like in `config.h` and run `make`, then `./wvkbd`
+
+## Contribute
+
+Any contributions are welcome, please tell me what I did wrong in issues or
+PRs. I could also use some nice branding if that tickles your fancy.
+
+For code contributions, all I ask for now is you run `make format` (requires
+`clang-format`) before opening a PR and include as much relevant detail as
+possible.

config.h

@@ -0,0 +1,165 @@
+/* constants */
+
+/* how tall the keyboard should be */
+#define KBD_PIXEL_HEIGHT 155
+
+/* if your layout leaves an empty margin, increase this to fix it */
+#define KBD_PIXEL_OVERSCAN_WIDTH 0
+
+/* rows for each layout */
+#define KBD_ROWS 4
+
+/* columns for each layout (maximum keys per row) */
+#define KBD_COLS 10
+
+/* spacing between keys */
+#define KBD_KEY_BORDER 1
+
+#include "keyboard.h"
+
+/* font (see `man fonts-conf` for instructions) */
+static const char *fc_font_pattern =
+  "monospace:size=14:antialias=true:hinting=true";
+
+/* layout declarations */
+enum layout_names {
+	Basic = 0,
+	Special,
+	NumLayouts,
+};
+
+static struct key keys_basic[], keys_special[];
+
+static struct layout layouts[NumLayouts] = {
+  [Basic] = {keys_basic},
+  [Special] = {keys_special},
+};
+
+/* keyboard settings */
+static struct kbd keyboard = {
+  /* default layout */
+  .layout = &layouts[Basic],
+  .scheme =
+    {
+      /* colors */
+      .bg = {.bgra = {15, 15, 15, 225}},
+      .fg = {.bgra = {45, 45, 45, 225}},
+      .high = {.bgra = {100, 100, 100, 225}},
+      .text = {.color = UINT32_MAX},
+    },
+};
+
+/* key layouts
+ *
+ * define keys like:
+ *
+ *  `{
+ *     "label",
+ *     "SHIFT_LABEL",
+ *     1,
+ *     [Code, Mod, Layout, Last],
+ *     [KEY_CODE, Modifier],
+ *     [&layout]
+ *  },`
+ *
+ * - label: normal label for key
+ *
+ * - shift_label: label for key in shifted (uppercase) layout
+ *
+ * - width: column width of key
+ *
+ * - type: what kind of action this key peforms (emit keycode, toggle modifier,
+ *   switch layout, or end the layout)
+ *
+ * - code: key scancode or modifier name (see
+ *   `/usr/include/linux/input-event-codes.h` for scancode names, and
+ *   `keyboard.h` for modifiers)
+ *
+ * - layout: layout to switch to when key is pressed
+ */
+static struct key keys_basic[] = {
+  {"q", "Q", 1, Code, KEY_Q},
+  {"w", "W", 1, Code, KEY_W},
+  {"e", "E", 1, Code, KEY_E},
+  {"r", "R", 1, Code, KEY_R},
+  {"t", "T", 1, Code, KEY_T},
+  {"y", "Y", 1, Code, KEY_Y},
+  {"u", "U", 1, Code, KEY_U},
+  {"i", "I", 1, Code, KEY_I},
+  {"o", "O", 1, Code, KEY_O},
+  {"p", "P", 1, Code, KEY_P},
+
+  {"a", "A", 1, Code, KEY_A},
+  {"s", "S", 1, Code, KEY_S},
+  {"d", "D", 1, Code, KEY_D},
+  {"f", "F", 1, Code, KEY_F},
+  {"g", "G", 1, Code, KEY_G},
+  {"h", "H", 1, Code, KEY_H},
+  {"j", "J", 1, Code, KEY_J},
+  {"k", "K", 1, Code, KEY_K},
+  {"l", "L", 1, Code, KEY_L},
+  {";", ":", 1, Code, KEY_SEMICOLON},
+
+  {"z", "Z", 1, Code, KEY_Z},
+  {"x", "X", 1, Code, KEY_X},
+  {"c", "C", 1, Code, KEY_C},
+  {"v", "V", 1, Code, KEY_V},
+  {"b", "B", 1, Code, KEY_B},
+  {"n", "N", 1, Code, KEY_N},
+  {"m", "M", 1, Code, KEY_M},
+  {"Tab", "Tab", 1, Code, KEY_TAB},
+  {"Bk", "Bk", 1, Code, KEY_BACKSPACE},
+  {"Ret", "Ret", 1, Code, KEY_ENTER},
+
+  {"Sft", "Sft", 1, Mod, Shift},
+  {"Sp", "Sp", 1, Mod, Super},
+  {"Alt", "Alt", 1, Mod, AltGr},
+  {"", "", 3, Code, KEY_SPACE},
+  {"Esc", "Esc", 1, Code, KEY_ESC},
+  {"Ctl", "Ctl", 1, Mod, Ctrl},
+  {"Sm", "Sm", 2, Layout, 0, &layouts[Special]},
+
+  /* end of layout */
+  {"", "", 0, Last},
+};
+
+static struct key keys_special[] = {
+  {"1", "!", 1, Code, KEY_1},
+  {"2", "@", 1, Code, KEY_2},
+  {"3", "#", 1, Code, KEY_3},
+  {"4", "$", 1, Code, KEY_4},
+  {"5", "%", 1, Code, KEY_5},
+  {"6", "^", 1, Code, KEY_6},
+  {"7", "&", 1, Code, KEY_7},
+  {"8", "*", 1, Code, KEY_8},
+  {"9", "(", 1, Code, KEY_9},
+  {"0", ")", 1, Code, KEY_0},
+
+  {"'", "\"", 1, Code, KEY_APOSTROPHE},
+  {"`", "~", 1, Code, KEY_GRAVE},
+  {"-", "_", 1, Code, KEY_MINUS},
+  {"=", "+", 1, Code, KEY_EQUAL},
+  {"[", "{", 1, Code, KEY_LEFTBRACE},
+  {"]", "}", 1, Code, KEY_RIGHTBRACE},
+  {",", "<", 1, Code, KEY_COMMA},
+  {".", ">", 1, Code, KEY_DOT},
+  {"/", "?", 1, Code, KEY_SLASH},
+  {"\\", "|", 1, Code, KEY_BACKSLASH},
+
+  {"↑", "↑", 1, Code, KEY_UP},
+  {"↓", "↓", 1, Code, KEY_DOWN},
+  {"←", "←", 1, Code, KEY_LEFT},
+  {"→", "→", 1, Code, KEY_RIGHT},
+  {"Sp", "Sp", 1, Mod, Super},
+  {"Alt", "Alt", 1, Mod, AltGr},
+  {"Ctl", "Ctl", 1, Mod, Ctrl},
+  {"Sft", "Sft", 1, Mod, Shift},
+
+  {"Ret", "Ret", 1, Code, KEY_ENTER},
+  {"Bk", "Bk", 1, Code, KEY_BACKSPACE},
+  {"", "", 3, Code, KEY_SPACE},
+  {"Bsc", "Bsc", 2, Layout, 0, &layouts[Basic]},
+
+  /* end of layout */
+  {"", "", 0, Last},
+};

config.mk

@@ -0,0 +1,2 @@
+VERSION = 0.0.1
+CFLAGS = -DVERSION=\"$(VERSION)\" -D_XOPEN_SOURCE=700

drw.c

@@ -0,0 +1,71 @@
+#include "wld/wayland.h"
+#include "wld/wld.h"
+#include <wayland-client.h>
+
+#include "drw.h"
+
+void
+drw_init(struct drw *d, const char *fc_pattern, struct wl_display *dpy,
+         void *iface) {
+	d->wld = wld_wayland_create_context(dpy, WLD_ANY, iface);
+	d->fctx = wld_font_create_context();
+	d->font = wld_font_open_name(d->fctx, fc_pattern);
+}
+
+void
+drwsurf_init(struct drw *d, struct drwsurf *ds, struct wl_surface *surf) {
+	ds->ctx = d;
+	ds->surf = surf;
+	ds->render = wld_create_renderer(d->wld);
+}
+
+void
+drwsurf_resize(struct drwsurf *ds, uint32_t w, uint32_t h) {
+	union wld_object obj;
+
+	if (ds->buf) {
+		wld_buffer_unreference(ds->buf);
+		ds->buf = NULL;
+		ds->ref = NULL;
+	}
+
+	ds->w = w;
+	ds->h = h;
+
+	ds->buf = wld_create_buffer(ds->ctx->wld, w, h, WLD_FORMAT_ARGB8888, 0);
+	wld_set_target_buffer(ds->render, ds->buf);
+
+	wld_export(ds->buf, WLD_WAYLAND_OBJECT_BUFFER, &obj);
+	ds->ref = obj.ptr;
+}
+
+static void surface_frame_callback(void *data, struct wl_callback *cb,
+                                   uint32_t time);
+
+static struct wl_callback_listener frame_listener = {.done =
+                                                       surface_frame_callback};
+
+void
+drwsurf_flip(struct drwsurf *ds) {
+	ds->cb = wl_surface_frame(ds->surf);
+	wl_callback_add_listener(ds->cb, &frame_listener, (void *)ds);
+
+	if (ds->dirty) {
+		wl_surface_damage(ds->surf, 0, 0, ds->w, ds->h);
+		wld_flush(ds->render);
+		wld_set_target_buffer(ds->render, ds->buf);
+		ds->dirty = false;
+	}
+
+	wl_surface_attach(ds->surf, ds->ref, 0, 0);
+	wl_surface_commit(ds->surf);
+}
+
+void
+surface_frame_callback(void *data, struct wl_callback *cb, uint32_t time) {
+	struct drwsurf *ds = (struct drwsurf *)data;
+	wl_callback_destroy(cb);
+	ds->cb = NULL;
+
+	drwsurf_flip(ds);
+}

drw.h

@@ -0,0 +1,37 @@
+#ifndef __DRW_H
+#define __DRW_H
+
+struct drw;
+struct drwsurf;
+
+void drw_init(struct drw *d, const char *fc_pattern, struct wl_display *dpy,
+              void *iface);
+void drwsurf_init(struct drw *d, struct drwsurf *ds, struct wl_surface *surf);
+void drwsurf_resize(struct drwsurf *ds, uint32_t w, uint32_t h);
+void drwsurf_flip(struct drwsurf *ds);
+
+struct drw {
+	struct wld_context *wld;
+	struct wld_font_context *fctx;
+	struct wld_font *font;
+};
+
+struct drwsurf {
+	uint32_t w, h;
+	bool dirty;
+
+	struct drw *ctx;
+	struct wl_surface *surf;
+	struct wld_renderer *render;
+	struct wld_buffer *buf;
+	struct wl_buffer *ref;
+
+	struct wl_callback *cb;
+};
+
+typedef union {
+	uint8_t bgra[4];
+	uint32_t color;
+} Color;
+
+#endif

keyboard.h

@@ -0,0 +1,217 @@
+/* clang-format off */
+#define KBD_POINTS KBD_ROWS * KBD_COLS
+/* clang-format on */
+
+enum key_type;
+enum key_modifier_type;
+struct clr_scheme;
+struct key;
+struct layout;
+struct kbd;
+
+enum key_type {
+	Pad = 0,
+	Code,
+	Mod,
+	Layout,
+	Last,
+};
+
+/* Modifiers passed to the virtual_keyboard protocol. They are based on
+ * wayland's wl_keyboard, which doesn't document them.
+ */
+enum key_modifier_type {
+	NoMod = 0,
+	Shift = 1,
+	CapsLock = 2,
+	Ctrl = 4,
+	Super = 64,
+	AltGr = 128,
+};
+
+struct clr_scheme {
+	Color fg;
+	Color bg;
+	Color high;
+	Color text;
+};
+
+struct key {
+	const char *label;
+	const char *shift_label;
+	const uint8_t width;
+	const enum key_type type;
+
+	const uint32_t code;
+	struct layout *layout;
+
+	uint8_t col, row;
+};
+
+struct layout {
+	struct key *keys;
+	struct key *gridpoints[KBD_POINTS];
+};
+
+struct kbd {
+	struct layout *layout;
+	struct clr_scheme scheme;
+
+	uint32_t w, h;
+	uint32_t kw, kh;
+	uint8_t mods;
+	struct key *last_press;
+
+	struct drwsurf *surf;
+	struct zwp_virtual_keyboard_v1 *vkbd;
+};
+
+static inline void draw_inset(struct drwsurf *d, uint32_t x, uint32_t y,
+                              uint32_t width, uint32_t height, uint32_t border,
+                              uint32_t color);
+
+static void kbd_init_layout(struct layout *l);
+static struct key *kbd_get_key(struct kbd *kb, uint32_t x, uint32_t y);
+static void kbd_unpress_key(struct kbd *kb, uint32_t time);
+static void kbd_press_key(struct kbd *kb, struct key *k, uint32_t time);
+static void kbd_draw_key(struct kbd *kb, struct key *k, bool pressed);
+static void kbd_draw_key(struct kbd *kb, struct key *k, bool pressed);
+static void kbd_draw_layout(struct kbd *kb);
+static void kbd_resize(struct kbd *kb, uint32_t w, uint32_t h);
+
+void
+kbd_init_layout(struct layout *l) {
+	uint8_t i = 0, width = 0, ncol = 0, col = 0, row = 0;
+
+	struct key *k = l->keys;
+	struct key **point = l->gridpoints,
+	           **end_point = l->gridpoints + (KBD_POINTS);
+
+	memset(point, 0, sizeof(uint8_t) * KBD_POINTS);
+
+	while ((k->type != Last) && (point < end_point)) {
+		width = k->width;
+		ncol = col + width;
+
+		if (ncol > KBD_COLS) {
+			width = KBD_COLS - col;
+			col = 0;
+			row += 1;
+
+			for (i = 0; (i < width) && (point < end_point); i++, point++) {
+			}
+			continue;
+		}
+
+		k->col = col;
+		k->row = row;
+		col = ncol;
+
+		for (i = 0; (i < width) && (point < end_point); i++, point++) {
+			*point = k;
+		}
+
+		k++;
+	}
+}
+
+struct key *
+kbd_get_key(struct kbd *kb, uint32_t x, uint32_t y) {
+	struct layout *l = kb->layout;
+	uint32_t col = KBD_COLS * ((float)x / (float)kb->w);
+	uint32_t row = KBD_ROWS * ((float)y / (float)kb->h);
+
+	return l->gridpoints[(row * KBD_COLS) + col];
+}
+
+void
+kbd_unpress_key(struct kbd *kb, uint32_t time) {
+	if (kb->last_press) {
+		kbd_draw_key(kb, kb->last_press, false);
+		kb->surf->dirty = true;
+
+		zwp_virtual_keyboard_v1_key(kb->vkbd, time, kb->last_press->code,
+		                            WL_KEYBOARD_KEY_STATE_RELEASED);
+		kb->last_press = NULL;
+	}
+}
+
+void
+kbd_press_key(struct kbd *kb, struct key *k, uint32_t time) {
+	switch (k->type) {
+	case Code:
+		kb->last_press = k;
+		kbd_draw_key(kb, k, true);
+		zwp_virtual_keyboard_v1_key(kb->vkbd, time, kb->last_press->code,
+		                            WL_KEYBOARD_KEY_STATE_PRESSED);
+		break;
+	case Mod:
+		kb->mods ^= k->code;
+		if (k->code == Shift) {
+			kbd_draw_layout(kb);
+		}
+		kbd_draw_key(kb, k, kb->mods & k->code);
+		zwp_virtual_keyboard_v1_modifiers(kb->vkbd, kb->mods, 0, 0, 0);
+		break;
+	case Layout:
+		kb->layout = k->layout;
+		kbd_draw_layout(kb);
+	default:
+		break;
+	}
+
+	kb->surf->dirty = true;
+}
+
+void
+kbd_draw_key(struct kbd *kb, struct key *k, bool pressed) {
+	struct drwsurf *d = kb->surf;
+	const char *label = (kb->mods & Shift) ? k->shift_label : k->label;
+	Color *fill = pressed ? &kb->scheme.high : &kb->scheme.fg;
+	uint32_t x = k->col * kb->kw, y = k->row * kb->kh, width = k->width * kb->kw;
+
+	draw_inset(d, x, y, width, kb->kh, KBD_KEY_BORDER, fill->color);
+	wld_draw_text(d->render, d->ctx->font, kb->scheme.text.color,
+	              x + (width * 0.35), y + (kb->kh / 2), label, -1, NULL);
+}
+
+void
+kbd_draw_layout(struct kbd *kb) {
+	struct drwsurf *d = kb->surf;
+	struct key *next_key = kb->layout->keys;
+	bool pressed = false;
+
+	wld_fill_rectangle(d->render, kb->scheme.bg.color, 0, 0, kb->w, kb->h);
+
+	while (next_key->type != Last) {
+		if (next_key->type == Pad) {
+			next_key++;
+			continue;
+		}
+		pressed = next_key->type == Mod && kb->mods & next_key->code;
+		kbd_draw_key(kb, next_key, pressed);
+		next_key++;
+	}
+}
+
+void
+kbd_resize(struct kbd *kb, uint32_t w, uint32_t h) {
+	struct drwsurf *d = kb->surf;
+
+	kb->w = w;
+	kb->h = h;
+
+	kb->kw = (float)w / (float)KBD_COLS;
+	kb->kh = (float)h / (float)KBD_ROWS;
+
+	drwsurf_resize(d, w, h);
+	kbd_draw_layout(kb);
+	d->dirty = true;
+}
+
+void
+draw_inset(struct drwsurf *d, uint32_t x, uint32_t y, uint32_t width,
+           uint32_t height, uint32_t border, uint32_t color) {
+	wld_fill_rectangle(d->render, color, x + border, y + border, width - border,
+	                   height - border);
+}

main.c

@@ -0,0 +1,352 @@
+#include "proto/virtual-keyboard-unstable-v1-client-protocol.h"
+#include "proto/wlr-layer-shell-unstable-v1-client-protocol.h"
+#include "wld/wayland.h"
+#include "wld/wld.h"
+#include <linux/input-event-codes.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/mman.h>
+#include <wayland-client.h>
+
+#include "drw.h"
+#include "keymap.h"
+#include "os-compatibility.h"
+
+/* lazy die macro */
+#define die(...)                                                               \
+	fprintf(stderr, __VA_ARGS__);                                                \
+	exit(0)
+
+/* client state */
+static const char *namespace = "wlroots";
+static struct wl_display *display;
+static struct wl_compositor *compositor;
+static struct wl_seat *seat;
+static struct wl_shm *shm;
+static struct wl_pointer *pointer;
+static struct wl_touch *touch;
+static struct wl_output *wl_output;
+static struct wl_surface *wl_surface;
+static struct zwlr_layer_shell_v1 *layer_shell;
+static struct zwlr_layer_surface_v1 *layer_surface;
+static struct zwp_virtual_keyboard_manager_v1 *vkbd_mgr;
+static uint32_t output = UINT32_MAX;
+
+/* drawing */
+static struct drw draw_ctx;
+static struct drwsurf draw_surf;
+
+/* layer surface parameters */
+static uint32_t layer = ZWLR_LAYER_SHELL_V1_LAYER_TOP;
+static uint32_t anchor = ZWLR_LAYER_SURFACE_V1_ANCHOR_BOTTOM |
+                         ZWLR_LAYER_SURFACE_V1_ANCHOR_LEFT |
+                         ZWLR_LAYER_SURFACE_V1_ANCHOR_RIGHT;
+
+/* application state */
+static bool run_display = true;
+static int cur_x = -1, cur_y = -1;
+
+/* event handler prototypes */
+static void wl_pointer_enter(void *data, struct wl_pointer *wl_pointer,
+                             uint32_t serial, struct wl_surface *surface,
+                             wl_fixed_t surface_x, wl_fixed_t surface_y);
+static void wl_pointer_leave(void *data, struct wl_pointer *wl_pointer,
+                             uint32_t serial, struct wl_surface *surface);
+static void wl_pointer_motion(void *data, struct wl_pointer *wl_pointer,
+                              uint32_t time, wl_fixed_t surface_x,
+                              wl_fixed_t surface_y);
+static void wl_pointer_button(void *data, struct wl_pointer *wl_pointer,
+                              uint32_t serial, uint32_t time, uint32_t button,
+                              uint32_t state);
+
+static void wl_touch_down(void *data, struct wl_touch *wl_touch,
+                          uint32_t serial, uint32_t time,
+                          struct wl_surface *surface, int32_t id, wl_fixed_t x,
+                          wl_fixed_t y);
+static void wl_touch_up(void *data, struct wl_touch *wl_touch, uint32_t serial,
+                        uint32_t time, int32_t id);
+static void wl_touch_motion(void *data, struct wl_touch *wl_touch,
+                            uint32_t time, int32_t id, wl_fixed_t x,
+                            wl_fixed_t y);
+static void wl_touch_frame(void *data, struct wl_touch *wl_touch);
+static void wl_touch_cancel(void *data, struct wl_touch *wl_touch);
+static void wl_touch_shape(void *data, struct wl_touch *wl_touch, int32_t id,
+                           wl_fixed_t major, wl_fixed_t minor);
+static void wl_touch_orientation(void *data, struct wl_touch *wl_touch,
+                                 int32_t id, wl_fixed_t orientation);
+
+static void seat_handle_capabilities(void *data, struct wl_seat *wl_seat,
+                                     enum wl_seat_capability caps);
+static void seat_handle_name(void *data, struct wl_seat *wl_seat,
+                             const char *name);
+
+static void handle_global(void *data, struct wl_registry *registry,
+                          uint32_t name, const char *interface,
+                          uint32_t version);
+static void handle_global_remove(void *data, struct wl_registry *registry,
+                                 uint32_t name);
+
+static void layer_surface_configure(void *data,
+                                    struct zwlr_layer_surface_v1 *surface,
+                                    uint32_t serial, uint32_t w, uint32_t h);
+static void layer_surface_closed(void *data,
+                                 struct zwlr_layer_surface_v1 *surface);
+
+/* event handlers */
+static const struct wl_pointer_listener pointer_listener = {
+  .enter = wl_pointer_enter,
+  .leave = wl_pointer_leave,
+  .motion = wl_pointer_motion,
+  .button = wl_pointer_button,
+};
+
+static const struct wl_touch_listener touch_listener = {
+  .down = wl_touch_down,
+  .up = wl_touch_up,
+  .motion = wl_touch_motion,
+  .frame = wl_touch_frame,
+  .cancel = wl_touch_cancel,
+  .shape = wl_touch_shape,
+  .orientation = wl_touch_orientation,
+};
+
+static const struct wl_seat_listener seat_listener = {
+  .capabilities = seat_handle_capabilities,
+  .name = seat_handle_name,
+};
+
+static const struct wl_registry_listener registry_listener = {
+  .global = handle_global,
+  .global_remove = handle_global_remove,
+};
+
+static const struct zwlr_layer_surface_v1_listener layer_surface_listener = {
+  .configure = layer_surface_configure,
+  .closed = layer_surface_closed,
+};
+
+#include "config.h"
+
+void
+wl_touch_down(void *data, struct wl_touch *wl_touch, uint32_t serial,
+              uint32_t time, struct wl_surface *surface, int32_t id,
+              wl_fixed_t x, wl_fixed_t y) {
+	struct key *next_key;
+	uint32_t touch_x, touch_y;
+
+	touch_x = wl_fixed_to_int(x);
+	touch_y = wl_fixed_to_int(y);
+
+	kbd_unpress_key(&keyboard, time);
+
+	next_key = kbd_get_key(&keyboard, touch_x, touch_y);
+	if (next_key) {
+		kbd_press_key(&keyboard, next_key, time);
+	}
+}
+
+void
+wl_touch_up(void *data, struct wl_touch *wl_touch, uint32_t serial,
+            uint32_t time, int32_t id) {
+	kbd_unpress_key(&keyboard, time);
+}
+
+void
+wl_touch_motion(void *data, struct wl_touch *wl_touch, uint32_t time,
+                int32_t id, wl_fixed_t x, wl_fixed_t y) {
+	kbd_unpress_key(&keyboard, time);
+}
+
+void
+wl_touch_frame(void *data, struct wl_touch *wl_touch) {}
+
+void
+wl_touch_cancel(void *data, struct wl_touch *wl_touch) {}
+
+void
+wl_touch_shape(void *data, struct wl_touch *wl_touch, int32_t id,
+               wl_fixed_t major, wl_fixed_t minor) {}
+
+void
+wl_touch_orientation(void *data, struct wl_touch *wl_touch, int32_t id,
+                     wl_fixed_t orientation) {}
+
+void
+wl_pointer_enter(void *data, struct wl_pointer *wl_pointer, uint32_t serial,
+                 struct wl_surface *surface, wl_fixed_t surface_x,
+                 wl_fixed_t surface_y) {}
+
+void
+wl_pointer_leave(void *data, struct wl_pointer *wl_pointer, uint32_t serial,
+                 struct wl_surface *surface) {
+	cur_x = cur_y = -1;
+}
+
+void
+wl_pointer_motion(void *data, struct wl_pointer *wl_pointer, uint32_t time,
+                  wl_fixed_t surface_x, wl_fixed_t surface_y) {
+	cur_x = wl_fixed_to_int(surface_x);
+	cur_y = wl_fixed_to_int(surface_y);
+
+	kbd_unpress_key(&keyboard, time);
+}
+
+void
+wl_pointer_button(void *data, struct wl_pointer *wl_pointer, uint32_t serial,
+                  uint32_t time, uint32_t button, uint32_t state) {
+	struct key *next_key;
+	bool press = state == WL_POINTER_BUTTON_STATE_PRESSED;
+
+	kbd_unpress_key(&keyboard, time);
+
+	if (press && cur_x >= 0 && cur_y >= 0) {
+		next_key = kbd_get_key(&keyboard, cur_x, cur_y);
+		if (next_key) {
+			kbd_press_key(&keyboard, next_key, time);
+		}
+	}
+}
+
+void
+seat_handle_capabilities(void *data, struct wl_seat *wl_seat,
+                         enum wl_seat_capability caps) {
+	if ((caps & WL_SEAT_CAPABILITY_POINTER)) {
+		pointer = wl_seat_get_pointer(wl_seat);
+		wl_pointer_add_listener(pointer, &pointer_listener, NULL);
+	}
+	if ((caps & WL_SEAT_CAPABILITY_TOUCH)) {
+		touch = wl_seat_get_touch(wl_seat);
+		wl_touch_add_listener(touch, &touch_listener, NULL);
+	}
+}
+
+void
+seat_handle_name(void *data, struct wl_seat *wl_seat, const char *name) {}
+
+void
+handle_global(void *data, struct wl_registry *registry, uint32_t name,
+              const char *interface, uint32_t version) {
+	if (strcmp(interface, wl_compositor_interface.name) == 0) {
+		compositor = wl_registry_bind(registry, name, &wl_compositor_interface, 1);
+	} else if (strcmp(interface, wl_shm_interface.name) == 0) {
+		shm = wl_registry_bind(registry, name, &wl_shm_interface, 1);
+	} else if (strcmp(interface, "wl_output") == 0) {
+		if (output != UINT32_MAX) {
+			if (!wl_output) {
+				wl_output = wl_registry_bind(registry, name, &wl_output_interface, 1);
+			} else {
+				output--;
+			}
+		}
+	} else if (strcmp(interface, wl_seat_interface.name) == 0) {
+		seat = wl_registry_bind(registry, name, &wl_seat_interface, 1);
+		wl_seat_add_listener(seat, &seat_listener, NULL);
+	} else if (strcmp(interface, zwlr_layer_shell_v1_interface.name) == 0) {
+		layer_shell =
+		  wl_registry_bind(registry, name, &zwlr_layer_shell_v1_interface, 1);
+	} else if (strcmp(interface,
+	                  zwp_virtual_keyboard_manager_v1_interface.name) == 0) {
+		vkbd_mgr = wl_registry_bind(registry, name,
+		                            &zwp_virtual_keyboard_manager_v1_interface, 1);
+	}
+}
+
+void
+handle_global_remove(void *data, struct wl_registry *registry, uint32_t name) {}
+
+void
+layer_surface_configure(void *data, struct zwlr_layer_surface_v1 *surface,
+                        uint32_t serial, uint32_t w, uint32_t h) {
+	kbd_resize(&keyboard, w + KBD_PIXEL_OVERSCAN_WIDTH, h);
+	zwlr_layer_surface_v1_ack_configure(surface, serial);
+}
+
+void
+layer_surface_closed(void *data, struct zwlr_layer_surface_v1 *surface) {
+	zwlr_layer_surface_v1_destroy(surface);
+	wl_surface_destroy(draw_surf.surf);
+	run_display = false;
+}
+
+int
+main(int argc, char **argv) {
+	uint8_t i;
+	int keymap_fd = os_create_anonymous_file(keymap_size);
+
+	/* connect to compositor */
+	display = wl_display_connect(NULL);
+	if (display == NULL) {
+		die("Failed to create display\n");
+	}
+
+	/* acquire state */
+	struct wl_registry *registry = wl_display_get_registry(display);
+	wl_registry_add_listener(registry, &registry_listener, NULL);
+	wl_display_roundtrip(display);
+
+	if (compositor == NULL) {
+		die("wl_compositor not available\n");
+	}
+	if (shm == NULL) {
+		die("wl_shm not available\n");
+	}
+	if (layer_shell == NULL) {
+		die("layer_shell not available\n");
+	}
+	if (vkbd_mgr == NULL) {
+		die("virtual_keyboard_manager not available\n");
+	}
+
+	/* create vkbd */
+	keyboard.vkbd =
+	  zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(vkbd_mgr, seat);
+
+	/* upload keymap */
+	if (keymap_fd < 0) {
+		die("could not create keymap fd\n");
+	}
+	void *ptr =
+	  mmap(NULL, keymap_size, PROT_READ | PROT_WRITE, MAP_SHARED, keymap_fd, 0);
+	if (ptr == (void *)-1) {
+		die("could not map keymap data\n");
+	}
+	strcpy(ptr, keymap_str);
+	zwp_virtual_keyboard_v1_keymap(
+	  keyboard.vkbd, WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1, keymap_fd, keymap_size);
+
+	/* init layouts */
+	for (i = 0; i < NumLayouts; i++) {
+		if (layouts[i].keys) {
+			kbd_init_layout(&layouts[i]);
+		}
+	}
+
+	/* assign kbd state */
+	keyboard.surf = &draw_surf;
+
+	/* create surface */
+	wl_surface = wl_compositor_create_surface(compositor);
+	drw_init(&draw_ctx, fc_font_pattern, display, shm);
+	drwsurf_init(&draw_ctx, &draw_surf, wl_surface);
+
+	layer_surface = zwlr_layer_shell_v1_get_layer_surface(
+	  layer_shell, draw_surf.surf, wl_output, layer, namespace);
+
+	zwlr_layer_surface_v1_set_size(layer_surface, 0, KBD_PIXEL_HEIGHT);
+	zwlr_layer_surface_v1_set_anchor(layer_surface, anchor);
+	zwlr_layer_surface_v1_set_exclusive_zone(layer_surface, KBD_PIXEL_HEIGHT);
+	zwlr_layer_surface_v1_set_keyboard_interactivity(layer_surface, false);
+	zwlr_layer_surface_v1_add_listener(layer_surface, &layer_surface_listener,
+	                                   NULL);
+	wl_surface_commit(draw_surf.surf);
+
+	/* flush requests and start drawing */
+	wl_display_roundtrip(display);
+	drwsurf_flip(&draw_surf);
+
+	while (wl_display_dispatch(display) != -1 && run_display) {
+	}
+
+	return 0;
+}

os-compatibility.c

@@ -0,0 +1,201 @@
+/*
+ * Copyright © 2012 Collabora, Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include <errno.h>
+#include <fcntl.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/epoll.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+#include "os-compatibility.h"
+
+int
+os_fd_set_cloexec(int fd) {
+	long flags;
+
+	if (fd == -1)
+		return -1;
+
+	flags = fcntl(fd, F_GETFD);
+	if (flags == -1)
+		return -1;
+
+	if (fcntl(fd, F_SETFD, flags | FD_CLOEXEC) == -1)
+		return -1;
+
+	return 0;
+}
+
+static int
+set_cloexec_or_close(int fd) {
+	if (os_fd_set_cloexec(fd) != 0) {
+		close(fd);
+		return -1;
+	}
+	return fd;
+}
+
+int
+os_socketpair_cloexec(int domain, int type, int protocol, int *sv) {
+	int ret;
+
+#ifdef SOCK_CLOEXEC
+	ret = socketpair(domain, type | SOCK_CLOEXEC, protocol, sv);
+	if (ret == 0 || errno != EINVAL)
+		return ret;
+#endif
+
+	ret = socketpair(domain, type, protocol, sv);
+	if (ret < 0)
+		return ret;
+
+	sv[0] = set_cloexec_or_close(sv[0]);
+	sv[1] = set_cloexec_or_close(sv[1]);
+
+	if (sv[0] != -1 && sv[1] != -1)
+		return 0;
+
+	close(sv[0]);
+	close(sv[1]);
+	return -1;
+}
+
+int
+os_epoll_create_cloexec(void) {
+	int fd;
+
+#ifdef EPOLL_CLOEXEC
+	fd = epoll_create1(EPOLL_CLOEXEC);
+	if (fd >= 0)
+		return fd;
+	if (errno != EINVAL)
+		return -1;
+#endif
+
+	fd = epoll_create(1);
+	return set_cloexec_or_close(fd);
+}
+
+static int
+create_tmpfile_cloexec(char *tmpname) {
+	int fd;
+
+#ifdef HAVE_MKOSTEMP
+	fd = mkostemp(tmpname, O_CLOEXEC);
+	if (fd >= 0)
+		unlink(tmpname);
+#else
+	fd = mkstemp(tmpname);
+	if (fd >= 0) {
+		fd = set_cloexec_or_close(fd);
+		unlink(tmpname);
+	}
+#endif
+
+	return fd;
+}
+
+/*
+ * Create a new, unique, anonymous file of the given size, and
+ * return the file descriptor for it. The file descriptor is set
+ * CLOEXEC. The file is immediately suitable for mmap()'ing
+ * the given size at offset zero.
+ *
+ * The file should not have a permanent backing store like a disk,
+ * but may have if XDG_RUNTIME_DIR is not properly implemented in OS.
+ *
+ * The file name is deleted from the file system.
+ *
+ * The file is suitable for buffer sharing between processes by
+ * transmitting the file descriptor over Unix sockets using the
+ * SCM_RIGHTS methods.
+ *
+ * If the C library implements posix_fallocate(), it is used to
+ * guarantee that disk space is available for the file at the
+ * given size. If disk space is insufficient, errno is set to ENOSPC.
+ * If posix_fallocate() is not supported, program may receive
+ * SIGBUS on accessing mmap()'ed file contents instead.
+ */
+int
+os_create_anonymous_file(off_t size) {
+	static const char template[] = "/weston-shared-XXXXXX";
+	const char *path;
+	char *name;
+	int fd;
+	int ret;
+
+	path = getenv("XDG_RUNTIME_DIR");
+	if (!path) {
+		errno = ENOENT;
+		return -1;
+	}
+
+	name = malloc(strlen(path) + sizeof(template));
+	if (!name)
+		return -1;
+
+	strcpy(name, path);
+	strcat(name, template);
+
+	fd = create_tmpfile_cloexec(name);
+
+	free(name);
+
+	if (fd < 0)
+		return -1;
+
+#ifdef HAVE_POSIX_FALLOCATE
+	do {
+		ret = posix_fallocate(fd, 0, size);
+	} while (ret == EINTR);
+	if (ret != 0) {
+		close(fd);
+		errno = ret;
+		return -1;
+	}
+#else
+	do {
+		ret = ftruncate(fd, size);
+	} while (ret < 0 && errno == EINTR);
+	if (ret < 0) {
+		close(fd);
+		return -1;
+	}
+#endif
+
+	return fd;
+}
+
+#ifndef MISSING_STRCHRNUL
+char *
+strchrnul(const char *s, int c) {
+	while (*s && *s != c)
+		s++;
+	return (char *)s;
+}
+#endif

os-compatibility.h

@@ -0,0 +1,52 @@
+/*
+ * Copyright © 2012 Collabora, Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef OS_COMPATIBILITY_H
+#define OS_COMPATIBILITY_H
+
+#include <sys/types.h>
+
+#ifdef HAVE_EXECINFO_H
+#include <execinfo.h>
+#else
+static inline int
+backtrace(void **buffer, int size) {
+	return 0;
+}
+#endif
+
+int os_fd_set_cloexec(int fd);
+
+int os_socketpair_cloexec(int domain, int type, int protocol, int *sv);
+
+int os_epoll_create_cloexec(void);
+
+int os_create_anonymous_file(off_t size);
+
+#ifdef MISSING_STRCHRNUL
+char *strchrnul(const char *s, int c);
+#endif
+
+#endif /* OS_COMPATIBILITY_H */

proto/virtual-keyboard-unstable-v1.xml

@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="virtual_keyboard_unstable_v1">
+  <copyright>
+    Copyright © 2008-2011  Kristian Høgsberg
+    Copyright © 2010-2013  Intel Corporation
+    Copyright © 2012-2013  Collabora, Ltd.
+    Copyright © 2018       Purism SPC
+
+    Permission is hereby granted, free of charge, to any person obtaining a
+    copy of this software and associated documentation files (the "Software"),
+    to deal in the Software without restriction, including without limitation
+    the rights to use, copy, modify, merge, publish, distribute, sublicense,
+    and/or sell copies of the Software, and to permit persons to whom the
+    Software is furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice (including the next
+    paragraph) shall be included in all copies or substantial portions of the
+    Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+    DEALINGS IN THE SOFTWARE.
+  </copyright>
+
+  <interface name="zwp_virtual_keyboard_v1" version="1">
+    <description summary="virtual keyboard">
+      The virtual keyboard provides an application with requests which emulate
+      the behaviour of a physical keyboard.
+
+      This interface can be used by clients on its own to provide raw input
+      events, or it can accompany the input method protocol.
+    </description>
+
+    <request name="keymap">
+      <description summary="keyboard mapping">
+        Provide a file descriptor to the compositor which can be
+        memory-mapped to provide a keyboard mapping description.
+
+        Format carries a value from the keymap_format enumeration.
+      </description>
+      <arg name="format" type="uint" summary="keymap format"/>
+      <arg name="fd" type="fd" summary="keymap file descriptor"/>
+      <arg name="size" type="uint" summary="keymap size, in bytes"/>
+    </request>
+
+    <enum name="error">
+      <entry name="no_keymap" value="0" summary="No keymap was set"/>
+    </enum>
+
+    <request name="key">
+      <description summary="key event">
+        A key was pressed or released.
+        The time argument is a timestamp with millisecond granularity, with an
+        undefined base. All requests regarding a single object must share the
+        same clock.
+
+        Keymap must be set before issuing this request.
+
+        State carries a value from the key_state enumeration.
+      </description>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
+      <arg name="key" type="uint" summary="key that produced the event"/>
+      <arg name="state" type="uint" summary="physical state of the key"/>
+    </request>
+
+    <request name="modifiers">
+      <description summary="modifier and group state">
+        Notifies the compositor that the modifier and/or group state has
+        changed, and it should update state.
+
+        The client should use wl_keyboard.modifiers event to synchronize its
+        internal state with seat state.
+
+        Keymap must be set before issuing this request.
+      </description>
+      <arg name="mods_depressed" type="uint" summary="depressed modifiers"/>
+      <arg name="mods_latched" type="uint" summary="latched modifiers"/>
+      <arg name="mods_locked" type="uint" summary="locked modifiers"/>
+      <arg name="group" type="uint" summary="keyboard layout"/>
+    </request>
+
+    <request name="destroy" type="destructor" since="1">
+      <description summary="destroy the virtual keyboard keyboard object"/>
+    </request>
+  </interface>
+
+  <interface name="zwp_virtual_keyboard_manager_v1" version="1">
+    <description summary="virtual keyboard manager">
+      A virtual keyboard manager allows an application to provide keyboard
+      input events as if they came from a physical keyboard.
+    </description>
+
+    <enum name="error">
+      <entry name="unauthorized" value="0" summary="client not authorized to use the interface"/>
+    </enum>
+
+    <request name="create_virtual_keyboard">
+      <description summary="Create a new virtual keyboard">
+        Creates a new virtual keyboard associated to a seat.
+
+        If the compositor enables a keyboard to perform arbitrary actions, it
+        should present an error when an untrusted client requests a new
+        keyboard.
+      </description>
+      <arg name="seat" type="object" interface="wl_seat"/>
+      <arg name="id" type="new_id" interface="zwp_virtual_keyboard_v1"/>
+    </request>
+  </interface>
+</protocol>

proto/wlr-layer-shell-unstable-v1.xml

@@ -0,0 +1,325 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="wlr_layer_shell_unstable_v1">
+  <copyright>
+    Copyright © 2017 Drew DeVault
+
+    Permission to use, copy, modify, distribute, and sell this
+    software and its documentation for any purpose is hereby granted
+    without fee, provided that the above copyright notice appear in
+    all copies and that both that copyright notice and this permission
+    notice appear in supporting documentation, and that the name of
+    the copyright holders not be used in advertising or publicity
+    pertaining to distribution of the software without specific,
+    written prior permission.  The copyright holders make no
+    representations about the suitability of this software for any
+    purpose.  It is provided "as is" without express or implied
+    warranty.
+
+    THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
+    SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+    FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
+    SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+    AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+    ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+    THIS SOFTWARE.
+  </copyright>
+
+  <interface name="zwlr_layer_shell_v1" version="3">
+    <description summary="create surfaces that are layers of the desktop">
+      Clients can use this interface to assign the surface_layer role to
+      wl_surfaces. Such surfaces are assigned to a "layer" of the output and
+      rendered with a defined z-depth respective to each other. They may also be
+      anchored to the edges and corners of a screen and specify input handling
+      semantics. This interface should be suitable for the implementation of
+      many desktop shell components, and a broad number of other applications
+      that interact with the desktop.
+    </description>
+
+    <request name="get_layer_surface">
+      <description summary="create a layer_surface from a surface">
+        Create a layer surface for an existing surface. This assigns the role of
+        layer_surface, or raises a protocol error if another role is already
+        assigned.
+
+        Creating a layer surface from a wl_surface which has a buffer attached
+        or committed is a client error, and any attempts by a client to attach
+        or manipulate a buffer prior to the first layer_surface.configure call
+        must also be treated as errors.
+
+        After creating a layer_surface object and setting it up, the client
+        must perform an initial commit without any buffer attached.
+        The compositor will reply with a layer_surface.configure event.
+        The client must acknowledge it and is then allowed to attach a buffer
+        to map the surface.
+
+        You may pass NULL for output to allow the compositor to decide which
+        output to use. Generally this will be the one that the user most
+        recently interacted with.
+
+        Clients can specify a namespace that defines the purpose of the layer
+        surface.
+      </description>
+      <arg name="id" type="new_id" interface="zwlr_layer_surface_v1"/>
+      <arg name="surface" type="object" interface="wl_surface"/>
+      <arg name="output" type="object" interface="wl_output" allow-null="true"/>
+      <arg name="layer" type="uint" enum="layer" summary="layer to add this surface to"/>
+      <arg name="namespace" type="string" summary="namespace for the layer surface"/>
+    </request>
+
+    <enum name="error">
+      <entry name="role" value="0" summary="wl_surface has another role"/>
+      <entry name="invalid_layer" value="1" summary="layer value is invalid"/>
+      <entry name="already_constructed" value="2" summary="wl_surface has a buffer attached or committed"/>
+    </enum>
+
+    <enum name="layer">
+      <description summary="available layers for surfaces">
+        These values indicate which layers a surface can be rendered in. They
+        are ordered by z depth, bottom-most first. Traditional shell surfaces
+        will typically be rendered between the bottom and top layers.
+        Fullscreen shell surfaces are typically rendered at the top layer.
+        Multiple surfaces can share a single layer, and ordering within a
+        single layer is undefined.
+      </description>
+
+      <entry name="background" value="0"/>
+      <entry name="bottom" value="1"/>
+      <entry name="top" value="2"/>
+      <entry name="overlay" value="3"/>
+    </enum>
+
+    <!-- Version 3 additions -->
+
+    <request name="destroy" type="destructor" since="3">
+      <description summary="destroy the layer_shell object">
+        This request indicates that the client will not use the layer_shell
+        object any more. Objects that have been created through this instance
+        are not affected.
+      </description>
+    </request>
+  </interface>
+
+  <interface name="zwlr_layer_surface_v1" version="3">
+    <description summary="layer metadata interface">
+      An interface that may be implemented by a wl_surface, for surfaces that
+      are designed to be rendered as a layer of a stacked desktop-like
+      environment.
+
+      Layer surface state (layer, size, anchor, exclusive zone,
+      margin, interactivity) is double-buffered, and will be applied at the
+      time wl_surface.commit of the corresponding wl_surface is called.
+
+      Attaching a null buffer to a layer surface unmaps it.
+
+      Unmapping a layer_surface means that the surface cannot be shown by the
+      compositor until it is explicitly mapped again. The layer_surface
+      returns to the state it had right after layer_shell.get_layer_surface.
+      The client can re-map the surface by performing a commit without any
+      buffer attached, waiting for a configure event and handling it as usual.
+    </description>
+
+    <request name="set_size">
+      <description summary="sets the size of the surface">
+        Sets the size of the surface in surface-local coordinates. The
+        compositor will display the surface centered with respect to its
+        anchors.
+
+        If you pass 0 for either value, the compositor will assign it and
+        inform you of the assignment in the configure event. You must set your
+        anchor to opposite edges in the dimensions you omit; not doing so is a
+        protocol error. Both values are 0 by default.
+
+        Size is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="width" type="uint"/>
+      <arg name="height" type="uint"/>
+    </request>
+
+    <request name="set_anchor">
+      <description summary="configures the anchor point of the surface">
+        Requests that the compositor anchor the surface to the specified edges
+        and corners. If two orthogonal edges are specified (e.g. 'top' and
+        'left'), then the anchor point will be the intersection of the edges
+        (e.g. the top left corner of the output); otherwise the anchor point
+        will be centered on that edge, or in the center if none is specified.
+
+        Anchor is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="anchor" type="uint" enum="anchor"/>
+    </request>
+
+    <request name="set_exclusive_zone">
+      <description summary="configures the exclusive geometry of this surface">
+        Requests that the compositor avoids occluding an area with other
+        surfaces. The compositor's use of this information is
+        implementation-dependent - do not assume that this region will not
+        actually be occluded.
+
+        A positive value is only meaningful if the surface is anchored to one
+        edge or an edge and both perpendicular edges. If the surface is not
+        anchored, anchored to only two perpendicular edges (a corner), anchored
+        to only two parallel edges or anchored to all edges, a positive value
+        will be treated the same as zero.
+
+        A positive zone is the distance from the edge in surface-local
+        coordinates to consider exclusive.
+
+        Surfaces that do not wish to have an exclusive zone may instead specify
+        how they should interact with surfaces that do. If set to zero, the
+        surface indicates that it would like to be moved to avoid occluding
+        surfaces with a positive exclusive zone. If set to -1, the surface
+        indicates that it would not like to be moved to accommodate for other
+        surfaces, and the compositor should extend it all the way to the edges
+        it is anchored to.
+
+        For example, a panel might set its exclusive zone to 10, so that
+        maximized shell surfaces are not shown on top of it. A notification
+        might set its exclusive zone to 0, so that it is moved to avoid
+        occluding the panel, but shell surfaces are shown underneath it. A
+        wallpaper or lock screen might set their exclusive zone to -1, so that
+        they stretch below or over the panel.
+
+        The default value is 0.
+
+        Exclusive zone is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="zone" type="int"/>
+    </request>
+
+    <request name="set_margin">
+      <description summary="sets a margin from the anchor point">
+        Requests that the surface be placed some distance away from the anchor
+        point on the output, in surface-local coordinates. Setting this value
+        for edges you are not anchored to has no effect.
+
+        The exclusive zone includes the margin.
+
+        Margin is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="top" type="int"/>
+      <arg name="right" type="int"/>
+      <arg name="bottom" type="int"/>
+      <arg name="left" type="int"/>
+    </request>
+
+    <request name="set_keyboard_interactivity">
+      <description summary="requests keyboard events">
+        Set to 1 to request that the seat send keyboard events to this layer
+        surface. For layers below the shell surface layer, the seat will use
+        normal focus semantics. For layers above the shell surface layers, the
+        seat will always give exclusive keyboard focus to the top-most layer
+        which has keyboard interactivity set to true.
+
+        Layer surfaces receive pointer, touch, and tablet events normally. If
+        you do not want to receive them, set the input region on your surface
+        to an empty region.
+
+        Events is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="keyboard_interactivity" type="uint"/>
+    </request>
+
+    <request name="get_popup">
+      <description summary="assign this layer_surface as an xdg_popup parent">
+        This assigns an xdg_popup's parent to this layer_surface.  This popup
+        should have been created via xdg_surface::get_popup with the parent set
+        to NULL, and this request must be invoked before committing the popup's
+        initial state.
+
+        See the documentation of xdg_popup for more details about what an
+        xdg_popup is and how it is used.
+      </description>
+      <arg name="popup" type="object" interface="xdg_popup"/>
+    </request>
+
+    <request name="ack_configure">
+      <description summary="ack a configure event">
+        When a configure event is received, if a client commits the
+        surface in response to the configure event, then the client
+        must make an ack_configure request sometime before the commit
+        request, passing along the serial of the configure event.
+
+        If the client receives multiple configure events before it
+        can respond to one, it only has to ack the last configure event.
+
+        A client is not required to commit immediately after sending
+        an ack_configure request - it may even ack_configure several times
+        before its next surface commit.
+
+        A client may send multiple ack_configure requests before committing, but
+        only the last request sent before a commit indicates which configure
+        event the client really is responding to.
+      </description>
+      <arg name="serial" type="uint" summary="the serial from the configure event"/>
+    </request>
+
+    <request name="destroy" type="destructor">
+      <description summary="destroy the layer_surface">
+        This request destroys the layer surface.
+      </description>
+    </request>
+
+    <event name="configure">
+      <description summary="suggest a surface change">
+        The configure event asks the client to resize its surface.
+
+        Clients should arrange their surface for the new states, and then send
+        an ack_configure request with the serial sent in this configure event at
+        some point before committing the new surface.
+
+        The client is free to dismiss all but the last configure event it
+        received.
+
+        The width and height arguments specify the size of the window in
+        surface-local coordinates.
+
+        The size is a hint, in the sense that the client is free to ignore it if
+        it doesn't resize, pick a smaller size (to satisfy aspect ratio or
+        resize in steps of NxM pixels). If the client picks a smaller size and
+        is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the
+        surface will be centered on this axis.
+
+        If the width or height arguments are zero, it means the client should
+        decide its own window dimension.
+      </description>
+      <arg name="serial" type="uint"/>
+      <arg name="width" type="uint"/>
+      <arg name="height" type="uint"/>
+    </event>
+
+    <event name="closed">
+      <description summary="surface should be closed">
+        The closed event is sent by the compositor when the surface will no
+        longer be shown. The output may have been destroyed or the user may
+        have asked for it to be removed. Further changes to the surface will be
+        ignored. The client should destroy the resource after receiving this
+        event, and create a new surface if they so choose.
+      </description>
+    </event>
+
+    <enum name="error">
+      <entry name="invalid_surface_state" value="0" summary="provided surface state is invalid"/>
+      <entry name="invalid_size" value="1" summary="size is invalid"/>
+      <entry name="invalid_anchor" value="2" summary="anchor bitfield is invalid"/>
+    </enum>
+
+    <enum name="anchor" bitfield="true">
+      <entry name="top" value="1" summary="the top edge of the anchor rectangle"/>
+      <entry name="bottom" value="2" summary="the bottom edge of the anchor rectangle"/>
+      <entry name="left" value="4" summary="the left edge of the anchor rectangle"/>
+      <entry name="right" value="8" summary="the right edge of the anchor rectangle"/>
+    </enum>
+
+    <!-- Version 2 additions -->
+
+    <request name="set_layer" since="2">
+      <description summary="change the layer of the surface">
+        Change the layer that the surface is rendered on.
+
+        Layer is double-buffered, see wl_surface.commit.
+      </description>
+      <arg name="layer" type="uint" enum="zwlr_layer_shell_v1.layer" summary="layer to move this surface to"/>
+    </request>
+  </interface>
+</protocol>

wld

@@ -0,0 +1 @@
+Subproject commit ea4eccb64cfcfc508b029a530fc434d6e6695af5