commit 5d012259d9c3e84a826048250a2cc2bab0e3abdc Author: Christian Hergert Date: Wed Feb 8 18:06:08 2023 -0800 initial commit This library doesn't do much yet. It contains the scaffolding and the rough shape of what I think the API should be in mks-types.h. Some of the types have some skeleton implementation as well to hid the D-Bus API behind those types. The next steps are to fill out the other wrapper objects and see what properties we should expose from the underlying D-Bus proxies. Along with that, will be a GtkWidget which can have a number of properties set on it to specify the MksScreen, MksKeyboard, and MksMouse devices. It may make sense to attach the session + screen to the widget, so that it can adapt to keyboard and mouse changes though. diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..8b840b4 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,22 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf + +[*.[ch]] +indent_size = 2 +indent_style = space +insert_final_newline = true +max_line_length = 100 +tab_width = 2 + +[*.xml] +indent_size = 2 +indent_style = space +max_line_length = 100 +tab_width = 2 + +[meson.build] +indent_size = 2 +indent_style = space diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..10926e8 --- /dev/null +++ b/COPYING @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..5631c1e --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# libmks + +This library provides a "Mouse, Keyboard, and Screen" to Qemu using the +D-Bus device support in Qemu and GTK 4. + diff --git a/lib/dbus-display1.xml b/lib/dbus-display1.xml new file mode 100644 index 0000000..c3b2293 --- /dev/null +++ b/lib/dbus-display1.xml @@ -0,0 +1,761 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/gconstructor.h b/lib/gconstructor.h new file mode 100644 index 0000000..29509e4 --- /dev/null +++ b/lib/gconstructor.h @@ -0,0 +1,161 @@ +/* GLIB - Library of useful routines for C programming + * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald + * + * SPDX-License-Identifier: LGPL-2.1-or-later + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, see . + */ + +/* + * Modified by the GLib Team and others 1997-2000. See the AUTHORS + * file for a list of people on the GLib Team. See the ChangeLog + * files for a list of changes. These files are distributed with + * GLib at ftp://ftp.gtk.org/pub/gtk/. + */ + +#ifndef __G_CONSTRUCTOR_H__ +#define __G_CONSTRUCTOR_H__ + +/* + If G_HAS_CONSTRUCTORS is true then the compiler support *both* constructors and + destructors, in a usable way, including e.g. on library unload. If not you're on + your own. + + Some compilers need #pragma to handle this, which does not work with macros, + so the way you need to use this is (for constructors): + + #ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA + #pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(my_constructor) + #endif + G_DEFINE_CONSTRUCTOR(my_constructor) + static void my_constructor(void) { + ... + } + +*/ + +#ifndef __GTK_DOC_IGNORE__ + +#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7) + +#define G_HAS_CONSTRUCTORS 1 + +#define G_DEFINE_CONSTRUCTOR(_func) static void __attribute__((constructor)) _func (void); +#define G_DEFINE_DESTRUCTOR(_func) static void __attribute__((destructor)) _func (void); + +#elif defined (_MSC_VER) && (_MSC_VER >= 1500) +/* Visual studio 2008 and later has _Pragma */ + +/* + * Only try to include gslist.h if not already included via glib.h, + * so that items using gconstructor.h outside of GLib (such as + * GResources) continue to build properly. + */ +#ifndef __G_LIB_H__ +#include "gslist.h" +#endif + +#include + +#define G_HAS_CONSTRUCTORS 1 + +/* We do some weird things to avoid the constructors being optimized + * away on VS2015 if WholeProgramOptimization is enabled. First we + * make a reference to the array from the wrapper to make sure its + * references. Then we use a pragma to make sure the wrapper function + * symbol is always included at the link stage. Also, the symbols + * need to be extern (but not dllexport), even though they are not + * really used from another object file. + */ + +/* We need to account for differences between the mangling of symbols + * for x86 and x64/ARM/ARM64 programs, as symbols on x86 are prefixed + * with an underscore but symbols on x64/ARM/ARM64 are not. + */ +#ifdef _M_IX86 +#define G_MSVC_SYMBOL_PREFIX "_" +#else +#define G_MSVC_SYMBOL_PREFIX "" +#endif + +#define G_DEFINE_CONSTRUCTOR(_func) G_MSVC_CTOR (_func, G_MSVC_SYMBOL_PREFIX) +#define G_DEFINE_DESTRUCTOR(_func) G_MSVC_DTOR (_func, G_MSVC_SYMBOL_PREFIX) + +#define G_MSVC_CTOR(_func,_sym_prefix) \ + static void _func(void); \ + extern int (* _array ## _func)(void); \ + int _func ## _wrapper(void) { _func(); g_slist_find (NULL, _array ## _func); return 0; } \ + __pragma(comment(linker,"/include:" _sym_prefix # _func "_wrapper")) \ + __pragma(section(".CRT$XCU",read)) \ + __declspec(allocate(".CRT$XCU")) int (* _array ## _func)(void) = _func ## _wrapper; + +#define G_MSVC_DTOR(_func,_sym_prefix) \ + static void _func(void); \ + extern int (* _array ## _func)(void); \ + int _func ## _constructor(void) { atexit (_func); g_slist_find (NULL, _array ## _func); return 0; } \ + __pragma(comment(linker,"/include:" _sym_prefix # _func "_constructor")) \ + __pragma(section(".CRT$XCU",read)) \ + __declspec(allocate(".CRT$XCU")) int (* _array ## _func)(void) = _func ## _constructor; + +#elif defined (_MSC_VER) + +#define G_HAS_CONSTRUCTORS 1 + +/* Pre Visual studio 2008 must use #pragma section */ +#define G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA 1 +#define G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA 1 + +#define G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(_func) \ + section(".CRT$XCU",read) +#define G_DEFINE_CONSTRUCTOR(_func) \ + static void _func(void); \ + static int _func ## _wrapper(void) { _func(); return 0; } \ + __declspec(allocate(".CRT$XCU")) static int (*p)(void) = _func ## _wrapper; + +#define G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(_func) \ + section(".CRT$XCU",read) +#define G_DEFINE_DESTRUCTOR(_func) \ + static void _func(void); \ + static int _func ## _constructor(void) { atexit (_func); return 0; } \ + __declspec(allocate(".CRT$XCU")) static int (* _array ## _func)(void) = _func ## _constructor; + +#elif defined(__SUNPRO_C) + +/* This is not tested, but i believe it should work, based on: + * http://opensource.apple.com/source/OpenSSL098/OpenSSL098-35/src/fips/fips_premain.c + */ + +#define G_HAS_CONSTRUCTORS 1 + +#define G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA 1 +#define G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA 1 + +#define G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(_func) \ + init(_func) +#define G_DEFINE_CONSTRUCTOR(_func) \ + static void _func(void); + +#define G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(_func) \ + fini(_func) +#define G_DEFINE_DESTRUCTOR(_func) \ + static void _func(void); + +#else + +/* constructors not supported for this compiler */ + +#endif + +#endif /* __GTK_DOC_IGNORE__ */ +#endif /* __G_CONSTRUCTOR_H__ */ diff --git a/lib/libmks.h b/lib/libmks.h new file mode 100644 index 0000000..20c0642 --- /dev/null +++ b/lib/libmks.h @@ -0,0 +1,37 @@ +/* libmks.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include + +G_BEGIN_DECLS + +#define MKS_INSIDE +# include "mks-init.h" +# include "mks-device.h" +# include "mks-screen.h" +# include "mks-session.h" +# include "mks-types.h" +# include "mks-version-macros.h" +# include "mks-version.h" +#undef MKS_INSIDE + +G_END_DECLS diff --git a/lib/meson.build b/lib/meson.build new file mode 100644 index 0000000..fa28025 --- /dev/null +++ b/lib/meson.build @@ -0,0 +1,81 @@ +libmks_sources = [ + 'mks-init.c', + 'mks-device.c', + 'mks-screen.c', + 'mks-session.c', +] + +libmks_private_sources = [ + 'mks-read-only-list-model.c', + + gnome.gdbus_codegen('mks-qemu', + autocleanup: 'all', + interface_prefix: 'org.qemu.Display1.', + namespace: 'MksQemu', + sources: 'dbus-display1.xml', + ) +] + +libmks_headers = [ + 'libmks.h', + 'mks-device.h', + 'mks-init.h', + 'mks-screen.h', + 'mks-session.h', + 'mks-types.h', +] + +# Setup mks-version.h for version checking +version_split = meson.project_version().split('.') +version_conf = configuration_data() +version_conf.set('VERSION', meson.project_version()) +version_conf.set('MAJOR_VERSION', version_split[0]) +version_conf.set('MINOR_VERSION', version_split[1]) +version_conf.set('MICRO_VERSION', version_split[2]) +configure_file( + input: 'mks-version.h.in', + output: 'mks-version.h', + configuration: version_conf, + install: true, + install_dir: join_paths(get_option('includedir'), 'libmks-@0@'.format(api_version)) +) + +libmks_deps = [ + libgio_dep, + libgiounix_dep, + libgtk_dep, +] + +libmks = shared_library('mks-' + api_version, + libmks_sources + libmks_private_sources, + dependencies: libmks_deps, + install: true, +) + +libmks_dep = declare_dependency( + link_with: libmks, + dependencies: libmks_deps, + include_directories: include_directories('.'), +) + +install_headers(libmks_headers, subdir: 'libmks-@0@'.format(api_version)) + +pkg.generate( + description: 'A shared library for Mouse, Keyboard, and Screen to Qemu', + libraries: libmks, + name: 'libmks', + filebase: 'libmks-' + api_version, + version: meson.project_version(), + subdirs: 'libmks-@0@'.format(api_version), + requires: ['gio-2.0', 'gio-unix-2.0', 'gtk4'], + install_dir: join_paths(get_option('libdir'), 'pkgconfig') +) + +libmks_gir = gnome.generate_gir(libmks, + nsversion: api_version, + namespace: 'Mks', + symbol_prefix: 'mks', + identifier_prefix: 'Mks', + includes: ['Gio-2.0', 'Gtk-4.0'], + install: true, +) \ No newline at end of file diff --git a/lib/mks-device-private.h b/lib/mks-device-private.h new file mode 100644 index 0000000..5017945 --- /dev/null +++ b/lib/mks-device-private.h @@ -0,0 +1,31 @@ +/* + * mks-device-private.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include "mks-device.h" + +G_BEGIN_DECLS + +void _mks_device_set_name (MksDevice *self, + const char *name); + +G_END_DECLS diff --git a/lib/mks-device.c b/lib/mks-device.c new file mode 100644 index 0000000..f286a6e --- /dev/null +++ b/lib/mks-device.c @@ -0,0 +1,112 @@ +/* + * mks-device.c + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#include "config.h" + +#include "mks-device-private.h" + +typedef struct +{ + char *name; +} MksDevicePrivate; + +G_DEFINE_TYPE_WITH_PRIVATE (MksDevice, mks_device, G_TYPE_OBJECT) + +enum { + PROP_0, + PROP_NAME, + N_PROPS +}; + +static GParamSpec *properties [N_PROPS]; + +static void +mks_device_finalize (GObject *object) +{ + MksDevice *self = (MksDevice *)object; + MksDevicePrivate *priv = mks_device_get_instance_private (self); + + g_clear_pointer (&priv->name, g_free); + + G_OBJECT_CLASS (mks_device_parent_class)->finalize (object); +} + +static void +mks_device_get_property (GObject *object, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + MksDevice *self = MKS_DEVICE (object); + + switch (prop_id) + { + case PROP_NAME: + g_value_set_string (value, mks_device_get_name (self)); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + } +} + +static void +mks_device_class_init (MksDeviceClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + object_class->finalize = mks_device_finalize; + object_class->get_property = mks_device_get_property; + + properties [PROP_NAME] = + g_param_spec_string ("name", NULL, NULL, + NULL, + (G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); + + g_object_class_install_properties (object_class, N_PROPS, properties); +} + +static void +mks_device_init (MksDevice *self) +{ +} + +const char * +mks_device_get_name (MksDevice *self) +{ + MksDevicePrivate *priv = mks_device_get_instance_private (self); + + g_return_val_if_fail (MKS_IS_DEVICE (self), NULL); + + return priv->name; +} + +void +_mks_device_set_name (MksDevice *self, + const char *name) +{ + MksDevicePrivate *priv = mks_device_get_instance_private (self); + + g_return_if_fail (MKS_IS_DEVICE (self)); + + if (g_set_str (&priv->name, name)) + g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_NAME]); +} diff --git a/lib/mks-device.h b/lib/mks-device.h new file mode 100644 index 0000000..4976928 --- /dev/null +++ b/lib/mks-device.h @@ -0,0 +1,47 @@ +/* + * mks-device.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include + +#include "mks-types.h" +#include "mks-version-macros.h" + +G_BEGIN_DECLS + +#define MKS_TYPE_DEVICE (mks_device_get_type()) + +MKS_AVAILABLE_IN_ALL +G_DECLARE_DERIVABLE_TYPE (MksDevice, mks_device, MKS, DEVICE, GObject) + +struct _MksDeviceClass +{ + GObjectClass parent_class; + + /*< private >*/ + gpointer _reserved[15]; +}; + +MKS_AVAILABLE_IN_ALL +const char *mks_device_get_name (MksDevice *self); + +G_END_DECLS diff --git a/lib/mks-init.c b/lib/mks-init.c new file mode 100644 index 0000000..12550a7 --- /dev/null +++ b/lib/mks-init.c @@ -0,0 +1,90 @@ +/* libmks.c + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#include "config.h" + +#include "gconstructor.h" + +#include "mks-device.h" +#include "mks-init.h" +#include "mks-qemu.h" +#include "mks-read-only-list-model-private.h" +#include "mks-session.h" +#include "mks-version.h" + +static void +mks_init_gtypes (void) +{ + /* First register GTypes for Qemu IPC */ + g_type_ensure (MKS_QEMU_TYPE_AUDIO); + g_type_ensure (MKS_QEMU_TYPE_AUDIO_IN_LISTENER); + g_type_ensure (MKS_QEMU_TYPE_AUDIO_OUT_LISTENER); + g_type_ensure (MKS_QEMU_TYPE_CHARDEV); + g_type_ensure (MKS_QEMU_TYPE_CLIPBOARD); + g_type_ensure (MKS_QEMU_TYPE_CONSOLE); + g_type_ensure (MKS_QEMU_TYPE_LISTENER); + g_type_ensure (MKS_QEMU_TYPE_MOUSE); + g_type_ensure (MKS_QEMU_TYPE_VM); + + /* Internal types not exposed in public API */ + g_type_ensure (MKS_TYPE_READ_ONLY_LIST_MODEL); + + /* GTypes that are part of our public API */ + g_type_ensure (MKS_TYPE_DEVICE); + g_type_ensure (MKS_TYPE_SESSION); +} + +void +mks_init (void) +{ + static gsize initialized; + + if (g_once_init_enter (&initialized)) + { + mks_init_gtypes (); + g_once_init_leave (&initialized, TRUE); + } +} + +G_DEFINE_CONSTRUCTOR (_mks_init) + +static void +_mks_init (void) +{ + mks_init (); +} + +int +mks_get_major_version (void) +{ + return MKS_MAJOR_VERSION; +} + +int +mks_get_minor_version (void) +{ + return MKS_MINOR_VERSION; +} + +int +mks_get_micro_version (void) +{ + return MKS_MICRO_VERSION; +} diff --git a/lib/mks-init.h b/lib/mks-init.h new file mode 100644 index 0000000..c00beea --- /dev/null +++ b/lib/mks-init.h @@ -0,0 +1,39 @@ +/* + * mks-init.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include + +#include "mks-version-macros.h" + +G_BEGIN_DECLS + +MKS_AVAILABLE_IN_ALL +void mks_init (void); +MKS_AVAILABLE_IN_ALL +int mks_get_major_version (void); +MKS_AVAILABLE_IN_ALL +int mks_get_minor_version (void); +MKS_AVAILABLE_IN_ALL +int mks_get_micro_version (void); + +G_END_DECLS diff --git a/lib/mks-read-only-list-model-private.h b/lib/mks-read-only-list-model-private.h new file mode 100644 index 0000000..c44c920 --- /dev/null +++ b/lib/mks-read-only-list-model-private.h @@ -0,0 +1,34 @@ +/* + * mks-read-only-list-model-private.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include + +G_BEGIN_DECLS + +#define MKS_TYPE_READ_ONLY_LIST_MODEL (mks_read_only_list_model_get_type()) + +G_DECLARE_FINAL_TYPE (MksReadOnlyListModel, mks_read_only_list_model, MKS, READ_ONLY_LIST_MODEL, GObject) + +GListModel *mks_read_only_list_model_new (GListModel *model); + +G_END_DECLS diff --git a/lib/mks-read-only-list-model.c b/lib/mks-read-only-list-model.c new file mode 100644 index 0000000..933e1b5 --- /dev/null +++ b/lib/mks-read-only-list-model.c @@ -0,0 +1,196 @@ +/* + * mks-read-only-list-model.c + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#include "config.h" + +#include "mks-read-only-list-model-private.h" + +struct _MksReadOnlyListModel +{ + GObject parent_instance; + GListModel *model; + gulong items_changed_handler; +}; + +static GType +mks_read_only_list_model_get_item_type (GListModel *model) +{ + MksReadOnlyListModel *self = MKS_READ_ONLY_LIST_MODEL (model); + + if (self->model != NULL) + return g_list_model_get_item_type (self->model); + + return G_TYPE_OBJECT; +} + +static guint +mks_read_only_list_model_get_n_items (GListModel *model) +{ + MksReadOnlyListModel *self = MKS_READ_ONLY_LIST_MODEL (model); + + if (self->model != NULL) + return g_list_model_get_n_items (self->model); + + return 0; +} + +static gpointer +mks_read_only_list_model_get_item (GListModel *model, + guint position) +{ + MksReadOnlyListModel *self = MKS_READ_ONLY_LIST_MODEL (model); + + if (self->model != NULL) + return g_list_model_get_item (self->model, position); + + return NULL; +} + +static void +list_model_iface_init (GListModelInterface *iface) +{ + iface->get_item_type = mks_read_only_list_model_get_item_type; + iface->get_n_items = mks_read_only_list_model_get_n_items; + iface->get_item = mks_read_only_list_model_get_item; +} + +G_DEFINE_FINAL_TYPE_WITH_CODE (MksReadOnlyListModel, mks_read_only_list_model, G_TYPE_OBJECT, + G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL, list_model_iface_init)) + +enum { + PROP_0, + PROP_N_ITEMS, + N_PROPS +}; + +static GParamSpec *properties [N_PROPS]; + +static void +mks_read_only_list_model_items_changed_cb (MksReadOnlyListModel *self, + guint position, + guint removed, + guint added, + GListModel *model) +{ + g_assert (MKS_IS_READ_ONLY_LIST_MODEL (self)); + g_assert (G_IS_LIST_MODEL (model)); + + if (removed == 0 && added == 0) + return; + + g_list_model_items_changed (G_LIST_MODEL (self), position, removed, added); + + if (removed != 0 || added != 0) + g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_N_ITEMS]); +} + +/** + * mks_read_only_list_model_new: + * @model: a #GListModel + * + * Creates a #GListModel which is read-only. + * + * This is useful for situations where you want to allow for observation + * of a list but restrict API access to the underlying #GListModel. + * + * Returns: (transfer full): a new #MksReadOnlyListModel + */ +GListModel * +mks_read_only_list_model_new (GListModel *model) +{ + MksReadOnlyListModel *self; + + g_return_val_if_fail (G_IS_LIST_MODEL (model), NULL); + + self = g_object_new (MKS_TYPE_READ_ONLY_LIST_MODEL, NULL); + + if (g_set_object (&self->model, model)) + self->items_changed_handler = + g_signal_connect_object (self->model, + "items-changed", + G_CALLBACK (mks_read_only_list_model_items_changed_cb), + self, + G_CONNECT_SWAPPED); + + return G_LIST_MODEL (self); +} + +static void +mks_read_only_list_model_dispose (GObject *object) +{ + MksReadOnlyListModel *self = (MksReadOnlyListModel *)object; + + if (self->model != NULL) + { + g_clear_signal_handler (&self->items_changed_handler, self->model); + g_clear_object (&self->model); + } + + G_OBJECT_CLASS (mks_read_only_list_model_parent_class)->dispose (object); +} + +static void +mks_read_only_list_model_get_property (GObject *object, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + MksReadOnlyListModel *self = MKS_READ_ONLY_LIST_MODEL (object); + + switch (prop_id) + { + case PROP_N_ITEMS: + g_value_set_uint (value, self->model ? g_list_model_get_n_items (self->model) : 0); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + } +} + +static void +mks_read_only_list_model_class_init (MksReadOnlyListModelClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + object_class->dispose = mks_read_only_list_model_dispose; + object_class->get_property = mks_read_only_list_model_get_property; + + /** + * MksReadOnlyListModel:n-items: + * + * The number of items in the underlying model. + * + * This is useful for binding in GtkBuilder UI definitions so that widgetry + * may be automatically hidden when the list is empty. + */ + properties [PROP_N_ITEMS] = + g_param_spec_uint ("n-items", NULL, NULL, + 0, G_MAXUINT, 0, + (G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); + + g_object_class_install_properties (object_class, N_PROPS, properties); +} + +static void +mks_read_only_list_model_init (MksReadOnlyListModel *self) +{ +} diff --git a/lib/mks-screen-private.h b/lib/mks-screen-private.h new file mode 100644 index 0000000..49b8dac --- /dev/null +++ b/lib/mks-screen-private.h @@ -0,0 +1,38 @@ +/* + * mks-screen-private.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include + +#include "mks-screen.h" + +G_BEGIN_DECLS + +void _mks_screen_new (GDBusConnection *connection, + const char *object_path, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +MksScreen *_mks_screen_new_finish (GAsyncResult *result, + GError **error); + +G_END_DECLS diff --git a/lib/mks-screen.c b/lib/mks-screen.c new file mode 100644 index 0000000..fe3ccaf --- /dev/null +++ b/lib/mks-screen.c @@ -0,0 +1,162 @@ +/* + * mks-screen.c + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#include "config.h" + +#include "mks-qemu.h" +#include "mks-screen-private.h" + +struct _MksScreen +{ + MksDevice parent_instance; + MksQemuConsole *console; +}; + +G_DEFINE_FINAL_TYPE (MksScreen, mks_screen, MKS_TYPE_DEVICE) + +enum { + PROP_0, + N_PROPS +}; + +static GParamSpec *properties [N_PROPS]; + +static void +mks_screen_dispose (GObject *object) +{ + MksScreen *self = (MksScreen *)object; + + g_clear_object (&self->console); + + G_OBJECT_CLASS (mks_screen_parent_class)->dispose (object); +} + +static void +mks_screen_get_property (GObject *object, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + MksScreen *self = MKS_SCREEN (object); + + switch (prop_id) + { + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + } +} + +static void +mks_screen_set_property (GObject *object, + guint prop_id, + const GValue *value, + GParamSpec *pspec) +{ + MksScreen *self = MKS_SCREEN (object); + + switch (prop_id) + { + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + } +} + +static void +mks_screen_class_init (MksScreenClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + object_class->dispose = mks_screen_dispose; + object_class->get_property = mks_screen_get_property; + object_class->set_property = mks_screen_set_property; +} + +static void +mks_screen_init (MksScreen *self) +{ +} + +static void +mks_screen_new_cb (GObject *object, + GAsyncResult *result, + gpointer user_data) +{ + g_autoptr(MksQemuConsole) console = NULL; + g_autoptr(GError) error = NULL; + g_autoptr(GTask) task = user_data; + MksScreen *self; + + g_assert (G_IS_ASYNC_RESULT (result)); + g_assert (G_IS_TASK (task)); + + self = g_task_get_source_object (task); + console = mks_qemu_console_proxy_new_finish (result, &error); + + g_assert (MKS_IS_SCREEN (self)); + g_assert (!console || MKS_QEMU_IS_CONSOLE (console)); + + self->console = g_steal_pointer (&console); + + if (error) + g_task_return_error (task, g_steal_pointer (&error)); + else + g_task_return_pointer (task, g_object_ref (self), g_object_unref); +} + +void +_mks_screen_new (GDBusConnection *connection, + const char *object_path, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + g_autoptr(GTask) task = NULL; + g_autoptr(MksScreen) self = NULL; + + g_return_if_fail (G_IS_DBUS_CONNECTION (connection)); + g_return_if_fail (object_path != NULL); + g_return_if_fail (!cancellable || G_IS_CANCELLABLE (cancellable)); + + self = g_object_new (MKS_TYPE_SCREEN, NULL); + task = g_task_new (self, cancellable, callback, user_data); + g_task_set_source_tag (task, _mks_screen_new); + + mks_qemu_console_proxy_new (connection, + G_DBUS_PROXY_FLAGS_NONE, + "org.qemu", + object_path, + cancellable, + mks_screen_new_cb, + g_steal_pointer (&task)); +} + +MksScreen * +_mks_screen_new_finish (GAsyncResult *result, + GError **error) +{ + MksScreen *ret; + + g_return_val_if_fail (G_IS_TASK (result), NULL); + ret = g_task_propagate_pointer (G_TASK (result), error); + g_return_val_if_fail (!ret || MKS_IS_SCREEN (ret), NULL); + + return ret; +} diff --git a/lib/mks-screen.h b/lib/mks-screen.h new file mode 100644 index 0000000..62b6f75 --- /dev/null +++ b/lib/mks-screen.h @@ -0,0 +1,35 @@ +/* + * mks-screen.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include + +#include "mks-device.h" + +G_BEGIN_DECLS + +#define MKS_TYPE_SCREEN (mks_screen_get_type()) + +MKS_AVAILABLE_IN_ALL +G_DECLARE_FINAL_TYPE (MksScreen, mks_screen, MKS, SCREEN, MksDevice) + +G_END_DECLS diff --git a/lib/mks-session.c b/lib/mks-session.c new file mode 100644 index 0000000..4347d69 --- /dev/null +++ b/lib/mks-session.c @@ -0,0 +1,608 @@ +/* + * mks-session.c + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#include "config.h" + +#include "mks-device.h" +#include "mks-read-only-list-model-private.h" +#include "mks-qemu.h" +#include "mks-session.h" + +/** + * SECTION:mks-session + * @Title: MksSession + * @Short_description: Session connected to a Qemu VM + * + * The #MksSession represents a connection to a Qemu VM instance. It contains + * devices such as the mouse, keyboard, and screen which can be used with GTK. + * + * You may monitor #MksSession:devices using #GListModel:items-changed to be + * notified of changes to available devices in the session. + * + * # Connecting To Qemu + * + * To use #MksSession, you should create your Qemu instance using `dbus` for + * the various devices that support it. You'll need to provide your P2P D-Bus + * address when connecting to Qemu. + * + * Using the same #GDBusConnection, create a #MksSession with + * mks_session_new_for_connection(). The #MksSession instance will negotiate + * with the peer to determine what devices are available and expose them + * via the #MksSession:devices #GListModel. + * + * # Creating Widgets + * + * You can create a new widget to embed in your application by waiting for + * a #MksScreen to become available in the list model or connecting to the + * #GObject::notify signal for the #MksSession:screen property. + */ + +static gboolean mks_session_initable_init (GInitable *initable, + GCancellable *cancellable, + GError **error); +static void mks_session_async_initable_init_async (GAsyncInitable *async_initable, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +static gboolean mks_session_async_initable_init_finish (GAsyncInitable *async_initable, + GAsyncResult *result, + GError **error); + +struct _MksSession +{ + GObject parent_instance; + + /* @connection is used to communicate with the Qemu instance. It is expected + * to be a private point-to-point connection over a Unix socket, socketpair(), + * or other channel capable of passing FDs between peers. + */ + GDBusConnection *connection; + + /* As devices are discovered from the Qemu instance, MksDevice-based objects + * are created for them and stored in @devices. Applications will work with + * these objects to perform operations on the Qemu instance. When we discover + * the devices have been removed, we drop them from the listmodel. + */ + GListStore *devices; + + /* @devices_read_only is a #MksReadOnlyListModel of @devices so that we may + * allow observation of the #GListModel, but without access to perturb it. + * Such opaqueness provides us a bit more assurance we don't leak + * implementation details into the API. + */ + GListModel *devices_read_only; + + /* @vm contains our "top-level" proxy object to the Qemu instance. This is + * where access to other devices begins. It is setup during either GInitable + * or GAsyncInitable initialization. + */ + MksQemuVM *vm; +}; + +static void +initable_iface_init (GInitableIface *iface) +{ + iface->init = mks_session_initable_init; +} + +static void +async_initable_iface_init (GAsyncInitableIface *iface) +{ + iface->init_async = mks_session_async_initable_init_async; + iface->init_finish = mks_session_async_initable_init_finish; +} + +G_DEFINE_FINAL_TYPE_WITH_CODE (MksSession, mks_session, G_TYPE_OBJECT, + G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init) + G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)) + +enum { + PROP_0, + PROP_CONNECTION, + PROP_DEVICES, + PROP_NAME, + PROP_UUID, + N_PROPS +}; + +static GParamSpec *properties [N_PROPS]; + +static void +mks_session_set_connection (MksSession *self, + GDBusConnection *connection) +{ + g_assert (MKS_IS_SESSION (self)); + g_assert (!connection || G_IS_DBUS_CONNECTION (connection)); + g_assert (self->connection == NULL); + + if (connection == NULL) + { + g_critical ("%s created without a GDBusConnection, this cannot work.", + G_OBJECT_TYPE_NAME (self)); + return; + } + + self->connection = g_object_ref (connection); +} + +static void +mks_session_vm_notify_cb (MksSession *self, + GParamSpec *pspec, + MksQemuVM *vm) +{ + g_assert (MKS_IS_SESSION (self)); + g_assert (pspec != NULL); + g_assert (MKS_QEMU_IS_VM (vm)); + + if (0) {} + else if (strcmp (pspec->name, "name") == 0) + g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_NAME]); + else if (strcmp (pspec->name, "uuid") == 0) + g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_UUID]); +} + +static void +mks_session_set_vm (MksSession *self, + MksQemuVM *vm) +{ + g_assert (MKS_IS_SESSION (self)); + g_assert (MKS_QEMU_IS_VM (vm)); + + g_signal_connect_object (vm, + "notify", + G_CALLBACK (mks_session_vm_notify_cb), + self, + G_CONNECT_SWAPPED); + + self->vm = g_object_ref (vm); +} + +static void +mks_session_dispose (GObject *object) +{ + MksSession *self = (MksSession *)object; + + if (self->devices != NULL) + g_list_store_remove_all (self->devices); + + G_OBJECT_CLASS (mks_session_parent_class)->dispose (object); +} + +static void +mks_session_finalize (GObject *object) +{ + MksSession *self = (MksSession *)object; + + g_clear_object (&self->vm); + g_clear_object (&self->devices); + g_clear_object (&self->devices_read_only); + g_clear_object (&self->connection); + + G_OBJECT_CLASS (mks_session_parent_class)->finalize (object); +} + +static void +mks_session_get_property (GObject *object, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + MksSession *self = MKS_SESSION (object); + + switch (prop_id) + { + case PROP_CONNECTION: + g_value_set_object (value, mks_session_get_connection (self)); + break; + + case PROP_DEVICES: + g_value_set_object (value, mks_session_get_devices (self)); + break; + + case PROP_NAME: + g_value_set_string (value, mks_session_get_name (self)); + break; + + case PROP_UUID: + g_value_set_string (value, mks_session_get_uuid (self)); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + } +} + +static void +mks_session_set_property (GObject *object, + guint prop_id, + const GValue *value, + GParamSpec *pspec) +{ + MksSession *self = MKS_SESSION (object); + + switch (prop_id) + { + case PROP_CONNECTION: + mks_session_set_connection (self, g_value_get_object (value)); + break; + + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); + } +} + +static void +mks_session_class_init (MksSessionClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + object_class->dispose = mks_session_dispose; + object_class->finalize = mks_session_finalize; + object_class->get_property = mks_session_get_property; + object_class->set_property = mks_session_set_property; + + /** + * MksSession:connection: + * + * The "connection" property contains the #GDBusConnection that is used + * to communicate with Qemu. + */ + properties [PROP_CONNECTION] = + g_param_spec_object ("connection", NULL, NULL, + G_TYPE_DBUS_CONNECTION, + (G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS)); + + /** + * MksSession:devices: + * + * The "devices" property contains a #GListModel of devices that have been + * discovered on the #GDBusConnection to Qemu. + */ + properties [PROP_DEVICES] = + g_param_spec_object ("devices", NULL, NULL, + G_TYPE_LIST_MODEL, + (G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); + + /** + * MksSession:name: + * + * The "name" property is the named of the VM as specified by the + * Qemu instance. + */ + properties [PROP_NAME] = + g_param_spec_string ("name", NULL, NULL, + NULL, + (G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); + + /** + * MksSession:uuid: + * + * The "uuid" property is the unique identifier as specified by the + * Qemu instance for the VM. + */ + properties [PROP_UUID] = + g_param_spec_string ("uuid", NULL, NULL, + NULL, + (G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); + + g_object_class_install_properties (object_class, N_PROPS, properties); +} + +static void +mks_session_init (MksSession *self) +{ + self->devices = g_list_store_new (MKS_TYPE_DEVICE); + self->devices_read_only = mks_read_only_list_model_new (G_LIST_MODEL (self->devices)); +} + +static gboolean +mks_session_initable_init (GInitable *initable, + GCancellable *cancellable, + GError **error) +{ + MksSession *self = (MksSession *)initable; + g_autoptr(MksQemuVM) vm = NULL; + + g_assert (MKS_IS_SESSION (self)); + g_assert (!cancellable || G_IS_CANCELLABLE (cancellable)); + + if (self->connection == NULL) + { + g_set_error (error, + G_IO_ERROR, + G_IO_ERROR_NOT_CONNECTED, + "Not connected"); + return FALSE; + } + + vm = mks_qemu_vm_proxy_new_sync (self->connection, + G_DBUS_PROXY_FLAGS_NONE, + "org.qemu", + "/org/qemu/Display1/VM", + cancellable, + error); + + if (vm != NULL) + mks_session_set_vm (self, vm); + + return vm != NULL; +} + +static void +mks_session_async_initable_vm_cb (GObject *object, + GAsyncResult *result, + gpointer user_data) +{ + g_autoptr(MksQemuVM) vm = NULL; + g_autoptr(GError) error = NULL; + g_autoptr(GTask) task = user_data; + MksSession *self; + + g_assert (G_IS_ASYNC_RESULT (result)); + g_assert (G_IS_TASK (task)); + + self = g_task_get_source_object (task); + vm = mks_qemu_vm_proxy_new_finish (result, &error); + + g_assert (MKS_IS_SESSION (self)); + g_assert (!vm || MKS_QEMU_IS_VM (vm)); + + if (vm != NULL) + mks_session_set_vm (self, vm); + + if (error) + g_task_return_error (task, g_steal_pointer (&error)); + else + g_task_return_boolean (task, TRUE); +} + +static void +mks_session_async_initable_init_async (GAsyncInitable *async_initable, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + MksSession *self = (MksSession *)async_initable; + g_autoptr(GTask) task = NULL; + + g_assert (MKS_IS_SESSION (self)); + g_assert (!cancellable || G_IS_CANCELLABLE (cancellable)); + + task = g_task_new (self, cancellable, callback, user_data); + g_task_set_source_tag (task, mks_session_async_initable_init_async); + g_task_set_priority (task, io_priority); + + if (self->connection == NULL) + g_task_return_new_error (task, + G_IO_ERROR, + G_IO_ERROR_NOT_CONNECTED, + "Not connected"); + else + mks_qemu_vm_proxy_new (self->connection, + G_DBUS_PROXY_FLAGS_NONE, + "org.qemu", + "/org/qemu/Display1/VM", + cancellable, + mks_session_async_initable_vm_cb, + g_steal_pointer (&task)); +} + +static gboolean +mks_session_async_initable_init_finish (GAsyncInitable *async_initable, + GAsyncResult *result, + GError **error) +{ + MksSession *self = (MksSession *)async_initable; + + g_assert (MKS_IS_SESSION (self)); + g_assert (G_IS_TASK (result)); + + return g_task_propagate_boolean (G_TASK (result), error); +} + +/** + * mks_session_get_devices: + * @self: a #MksSession + * + * Gets a #GListModel of devices connected to the session. + * + * Returns: (transfer none): a #GListModel of #MksDevice + */ +GListModel * +mks_session_get_devices (MksSession *self) +{ + g_return_val_if_fail (MKS_IS_SESSION (self), NULL); + + return self->devices_read_only; +} + +static void +mks_session_new_for_connection_cb (GObject *object, + GAsyncResult *result, + gpointer user_data) +{ + MksSession *self = (MksSession *)object; + g_autoptr(GError) error = NULL; + g_autoptr(GTask) task = user_data; + + g_assert (MKS_IS_SESSION (self)); + g_assert (G_IS_ASYNC_RESULT (result)); + g_assert (G_IS_TASK (task)); + + if (!g_async_initable_init_finish (G_ASYNC_INITABLE (self), result, &error)) + g_task_return_error (task, g_steal_pointer (&error)); + else + g_task_return_pointer (task, g_object_ref (self), g_object_unref); +} + +/** + * mks_session_new_for_connection: + * @connection: a #GDBusConnection + * @io_priority: priority for IO operations + * @cancellable: (nullable): a #GCancellable or %NULL + * @callback: a callback to execute upon completion of the operation + * @user_data: closure data for @callback + * + * Creates a #MksSession which communicates using @connection. + * + * The #GDBusConnection should be a private D-Bus connection to a Qemu + * instance which has devices created using the "dbus" backend. + + * @callback will be executed when the session has been created or + * failed to create. + * + * This function will not block the calling thread. + * + * use mks_session_new_for_connection_finish() to get the result of + * this operation. + */ +void +mks_session_new_for_connection (GDBusConnection *connection, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + g_autoptr(MksSession) self = NULL; + g_autoptr(GTask) task = NULL; + + g_return_if_fail (G_IS_DBUS_CONNECTION (connection)); + g_return_if_fail (!cancellable || G_IS_CANCELLABLE (cancellable)); + + self = g_object_new (MKS_TYPE_SESSION, + "connection", connection, + NULL); + + task = g_task_new (self, cancellable, callback, user_data); + g_task_set_source_tag (task, mks_session_new_for_connection); + g_task_set_priority (task, io_priority); + + g_async_initable_init_async (G_ASYNC_INITABLE (self), + io_priority, + cancellable, + mks_session_new_for_connection_cb, + g_steal_pointer (&task)); +} + +/** + * mks_session_new_for_connection_finish: + * @result: a #GAsyncResult provided to callback + * @error: (nullable): a location for a #GError or %NULL + * + * Completes a request to create a #MksSession for a #GDBusConnection. + * + * Returns: (transfer full): a #MksSession if successful; otherwise %NULL + * and @error is set. + */ +MksSession * +mks_session_new_for_connection_finish (GAsyncResult *result, + GError **error) +{ + g_return_val_if_fail (G_IS_TASK (result), NULL); + + return g_task_propagate_pointer (G_TASK (result), error); +} + +/** + * mks_session_new_for_connection_sync: + * @connection: a private #GDBusConnetion to a Qemu instance + * @cancellable: (nullable): a #GCancellable, or %NULL + * @error: (nullable): a location for a #GError, or %NULL + * + * Synchronously creates a new #MksSession instance. + * + * This may block while the Qemu instance is contacted to query for + * initial devices and VM status. + * + * Returns: (transfer full): a #MksSession if successful; otherwise %NULL + * and @error is set. + */ +MksSession * +mks_session_new_for_connection_sync (GDBusConnection *connection, + GCancellable *cancellable, + GError **error) +{ + g_autoptr(MksSession) self = NULL; + + g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL); + + self = g_object_new (MKS_TYPE_SESSION, + "connection", connection, + NULL); + + if (g_initable_init (G_INITABLE (self), cancellable, error)) + return g_steal_pointer (&self); + + return NULL; +} + +/** + * mks_session_get_connection: + * @self: a #MksSession + * + * Gets the #MksSession:connection property. + * + * Returns: (transfer none) (nullable): a #GDBusConnection or %NULL if + * the connection has not been set, or was disposed. + */ +GDBusConnection * +mks_session_get_connection (MksSession *self) +{ + g_return_val_if_fail (MKS_IS_SESSION (self), NULL); + + return self->connection; +} + +/** + * mks_session_get_uuid: + * @self: a #MksSession + * + * Gets the "uuid" property. + */ +const char * +mks_session_get_uuid (MksSession *self) +{ + g_return_val_if_fail (MKS_IS_SESSION (self), NULL); + + if (self->vm != NULL) + return mks_qemu_vm_get_uuid (self->vm); + + return NULL; +} + +/** + * mks_session_get_name: + * @self: a #MksSession + * + * Gets the "name" property. + */ +const char * +mks_session_get_name (MksSession *self) +{ + g_return_val_if_fail (MKS_IS_SESSION (self), NULL); + + if (self->vm != NULL) + return mks_qemu_vm_get_name (self->vm); + + return NULL; +} diff --git a/lib/mks-session.h b/lib/mks-session.h new file mode 100644 index 0000000..be255fe --- /dev/null +++ b/lib/mks-session.h @@ -0,0 +1,58 @@ +/* + * mks-session.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include + +#include "mks-types.h" +#include "mks-version-macros.h" + +G_BEGIN_DECLS + +#define MKS_TYPE_SESSION (mks_session_get_type()) + +MKS_AVAILABLE_IN_ALL +G_DECLARE_FINAL_TYPE (MksSession, mks_session, MKS, SESSION, GObject) + +MKS_AVAILABLE_IN_ALL +void mks_session_new_for_connection (GDBusConnection *connection, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +MKS_AVAILABLE_IN_ALL +MksSession *mks_session_new_for_connection_finish (GAsyncResult *result, + GError **error); +MKS_AVAILABLE_IN_ALL +MksSession *mks_session_new_for_connection_sync (GDBusConnection *connection, + GCancellable *cancellable, + GError **error); +MKS_AVAILABLE_IN_ALL +GDBusConnection *mks_session_get_connection (MksSession *self); +MKS_AVAILABLE_IN_ALL +GListModel *mks_session_get_devices (MksSession *self); +MKS_AVAILABLE_IN_ALL +const char *mks_session_get_name (MksSession *self); +MKS_AVAILABLE_IN_ALL +const char *mks_session_get_uuid (MksSession *self); + +G_END_DECLS diff --git a/lib/mks-types.h b/lib/mks-types.h new file mode 100644 index 0000000..6d27df6 --- /dev/null +++ b/lib/mks-types.h @@ -0,0 +1,39 @@ +/* + * mks-types.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include + +G_BEGIN_DECLS + +typedef struct _MksAudio MksAudio; +typedef struct _MksChardev MksChardev; +typedef struct _MksClipboard MksClipboard; +typedef struct _MksDevice MksDevice; +typedef struct _MksKeyboard MksKeyboard; +typedef struct _MksMouse MksMouse; +typedef struct _MksScreen MksScreen; +typedef struct _MksSerial MksSerial; +typedef struct _MksSession MksSession; +typedef struct _MksUsb MksUsb; + +G_END_DECLS diff --git a/lib/mks-version-macros.h b/lib/mks-version-macros.h new file mode 100644 index 0000000..e89130e --- /dev/null +++ b/lib/mks-version-macros.h @@ -0,0 +1,106 @@ +/* mks-version-macros.h + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#include + +#include "mks-version.h" + +#ifndef _MKS_EXTERN +# define _MKS_EXTERN extern +#endif + +#define MKS_VERSION_CUR_STABLE (G_ENCODE_VERSION (MKS_MAJOR_VERSION, 0)) + +#ifdef MKS_DISABLE_DEPRECATION_WARNINGS +# define MKS_DEPRECATED _MKS_EXTERN +# define MKS_DEPRECATED_FOR(f) _MKS_EXTERN +# define MKS_UNAVAILABLE(maj,min) _MKS_EXTERN +#else +# define MKS_DEPRECATED G_DEPRECATED _MKS_EXTERN +# define MKS_DEPRECATED_FOR(f) G_DEPRECATED_FOR (f) _MKS_EXTERN +# define MKS_UNAVAILABLE(maj,min) G_UNAVAILABLE (maj, min) _MKS_EXTERN +#endif + +#define MKS_VERSION_1_0 (G_ENCODE_VERSION (1, 0)) + +#if MKS_MAJOR_VERSION == MKS_VERSION_1_0 +# define MKS_VERSION_PREV_STABLE (MKS_VERSION_1_0) +#else +# define MKS_VERSION_PREV_STABLE (G_ENCODE_VERSION (MKS_MAJOR_VERSION - 1, 0)) +#endif + +/** + * MKS_VERSION_MIN_REQUIRED: + * + * A macro that should be defined by the user prior to including + * the mks.h header. + * + * The definition should be one of the predefined MKS version + * macros: %MKS_VERSION_1_0, ... + * + * This macro defines the lower bound for the Builder API to use. + * + * If a function has been deprecated in a newer version of Builder, + * it is possible to use this symbol to avoid the compiler warnings + * without disabling warning for every deprecated function. + */ +#ifndef MKS_VERSION_MIN_REQUIRED +# define MKS_VERSION_MIN_REQUIRED (MKS_VERSION_CUR_STABLE) +#endif + +/** + * MKS_VERSION_MAX_ALLOWED: + * + * A macro that should be defined by the user prior to including + * the mks.h header. + + * The definition should be one of the predefined Builder version + * macros: %MKS_VERSION_1_0, %MKS_VERSION_44,... + * + * This macro defines the upper bound for the MKS API to use. + * + * If a function has been introduced in a newer version of Builder, + * it is possible to use this symbol to get compiler warnings when + * trying to use that function. + */ +#ifndef MKS_VERSION_MAX_ALLOWED +# if MKS_VERSION_MIN_REQUIRED > MKS_VERSION_PREV_STABLE +# define MKS_VERSION_MAX_ALLOWED (MKS_VERSION_MIN_REQUIRED) +# else +# define MKS_VERSION_MAX_ALLOWED (MKS_VERSION_CUR_STABLE) +# endif +#endif + +#define MKS_AVAILABLE_IN_ALL _MKS_EXTERN + +#if MKS_VERSION_MIN_REQUIRED >= MKS_VERSION_1_0 +# define MKS_DEPRECATED_IN_1_0 MKS_DEPRECATED +# define MKS_DEPRECATED_IN_1_0_FOR(f) MKS_DEPRECATED_FOR(f) +#else +# define MKS_DEPRECATED_IN_1_0 _MKS_EXTERN +# define MKS_DEPRECATED_IN_1_0_FOR(f) _MKS_EXTERN +#endif +#if MKS_VERSION_MAX_ALLOWED < MKS_VERSION_1_0 +# define MKS_AVAILABLE_IN_1_0 MKS_UNAVAILABLE(1, 0) +#else +# define MKS_AVAILABLE_IN_1_0 _MKS_EXTERN +#endif diff --git a/lib/mks-version.h.in b/lib/mks-version.h.in new file mode 100644 index 0000000..3e4144b --- /dev/null +++ b/lib/mks-version.h.in @@ -0,0 +1,96 @@ +/* mks-version.h.in + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#pragma once + +#if !defined(MKS_INSIDE) && !defined(MKS_COMPILATION) +# error "Only can be included directly." +#endif + +/** + * SECTION:mksversion + * @short_description: mks version checking + * + * mks provides macros to check the version of the library + * at compile-time + */ + +/** + * MKS_MAJOR_VERSION: + * + * mks major version component (e.g. 1 if %MKS_VERSION is 1.2.3) + */ +#define MKS_MAJOR_VERSION (@MAJOR_VERSION@) + +/** + * MKS_MINOR_VERSION: + * + * mks minor version component (e.g. 2 if %MKS_VERSION is 1.2.3) + */ +#define MKS_MINOR_VERSION (@MINOR_VERSION@) + +/** + * MKS_MICRO_VERSION: + * + * mks micro version component (e.g. 3 if %MKS_VERSION is 1.2.3) + */ +#define MKS_MICRO_VERSION (@MICRO_VERSION@) + +/** + * MKS_VERSION + * + * mks version. + */ +#define MKS_VERSION (@VERSION@) + +/** + * MKS_VERSION_S: + * + * mks version, encoded as a string, useful for printing and + * concatenation. + */ +#define MKS_VERSION_S "@VERSION@" + +#define MKS_ENCODE_VERSION(major,minor,micro) \ + ((major) << 24 | (minor) << 16 | (micro) << 8) + +/** + * MKS_VERSION_HEX: + * + * mks version, encoded as an hexadecimal number, useful for + * integer comparisons. + */ +#define MKS_VERSION_HEX \ + (MKS_ENCODE_VERSION (MKS_MAJOR_VERSION, MKS_MINOR_VERSION, MKS_MICRO_VERSION)) + +/** + * MKS_CHECK_VERSION: + * @major: required major version + * @minor: required minor version + * @micro: required micro version + * + * Compile-time version checking. Evaluates to %TRUE if the version + * of mks is greater than the required one. + */ +#define MKS_CHECK_VERSION(major,minor,micro) \ + (MKS_MAJOR_VERSION > (major) || \ + (MKS_MAJOR_VERSION == (major) && MKS_MINOR_VERSION > (minor)) || \ + (MKS_MAJOR_VERSION == (major) && MKS_MINOR_VERSION == (minor) && \ + MKS_MICRO_VERSION >= (micro))) diff --git a/meson.build b/meson.build new file mode 100644 index 0000000..01ea0cd --- /dev/null +++ b/meson.build @@ -0,0 +1,157 @@ +project('libmks', 'c', + version: '0.1.0', + meson_version: '>= 0.62.0', + default_options: ['warning_level=2', 'werror=false', 'c_std=gnu11'], +) + +api_version = '1' + +cc = meson.get_compiler('c') +gnome = import('gnome') +pkg = import('pkgconfig') + +project_c_args = ['-DMKS_COMPILATION'] + +# Setup config.h and ensure -I includes path to it +config_h = configuration_data() +config_h.set_quoted('GETTEXT_PACKAGE', 'libmks-@0@'.format(api_version)) +config_h.set_quoted('PACKAGE_VERSION', meson.project_version()) +add_project_arguments(['-I' + meson.project_build_root()], language: 'c') + +# Check dependencies +glib_req_version = '2.75.0' +gtk_req_version = '4.8' + +glib_req = '>= @0@'.format(glib_req_version) +gtk_req = '>= @0@'.format(gtk_req_version) + +glib_major = glib_req_version.split('.')[0].to_int() +glib_minor = glib_req_version.split('.')[1].to_int() +gtk_major = gtk_req_version.split('.')[0].to_int() +gtk_minor = gtk_req_version.split('.')[1].to_int() + +if glib_minor % 2 == 1 + glib_minor = glib_minor + 1 +endif +if gtk_minor % 2 == 1 + gtk_minor = gtk_minor + 1 +endif + +libgio_dep = dependency('gio-2.0', version: glib_req) +libgiounix_dep = dependency('gio-unix-2.0', version: glib_req) +libgtk_dep = dependency('gtk4', version: gtk_req) + +# Ensure we restrict ABI usage to what we claim +project_c_args += [ + '-DGLIB_VERSION_MIN_REQUIRED=GLIB_VERSION_@0@_@1@'.format(glib_major, glib_minor), + '-DGLIB_VERSION_MAX_ALLOWED=GLIB_VERSION_@0@_@1@'.format(glib_major, glib_minor), + '-DGDK_VERSION_MIN_REQUIRED=GDK_VERSION_@0@_@1@'.format(gtk_major, gtk_minor), + '-DGDK_VERSION_MAX_ALLOWED=GDK_VERSION_@0@_@1@'.format(gtk_major, gtk_minor), +] + +test_c_args = [ + '-Wcast-align', + '-Wdeclaration-after-statement', + '-Werror=address', + '-Werror=array-bounds', + '-Werror=empty-body', + '-Werror=implicit', + '-Werror=implicit-function-declaration', + '-Werror=incompatible-pointer-types', + '-Werror=init-self', + '-Werror=int-conversion', + '-Werror=int-to-pointer-cast', + '-Werror=main', + '-Werror=misleading-indentation', + '-Werror=missing-braces', + '-Werror=missing-include-dirs', + '-Werror=nonnull', + '-Werror=overflow', + '-Werror=parenthesis', + '-Werror=pointer-arith', + '-Werror=pointer-to-int-cast', + '-Werror=redundant-decls', + '-Werror=return-type', + '-Werror=sequence-point', + '-Werror=shadow', + '-Werror=strict-prototypes', + '-Werror=trigraphs', + '-Werror=undef', + '-Werror=write-strings', + '-Wformat-nonliteral', + '-Wignored-qualifiers', + '-Wimplicit-function-declaration', + '-Wlogical-op', + '-Wmissing-declarations', + '-Wmissing-format-attribute', + '-Wmissing-include-dirs', + '-Wmissing-noreturn', + '-Wnested-externs', + '-Wno-cast-function-type', + '-Wno-dangling-pointer', + '-Wno-missing-field-initializers', + '-Wno-sign-compare', + '-Wno-unused-parameter', + '-Wold-style-definition', + '-Wpointer-arith', + '-Wredundant-decls', + '-Wstrict-prototypes', + '-Wswitch-default', + '-Wswitch-enum', + '-Wundef', + '-Wuninitialized', + '-Wunused', + '-fno-strict-aliasing', + ['-Werror=format-security', '-Werror=format=2'], +] +if get_option('buildtype') != 'plain' + test_c_args += '-fstack-protector-strong' +endif +foreach arg: test_c_args + if cc.has_multi_arguments(arg) + project_c_args += arg + endif +endforeach +hidden_visibility_args = [] +if get_option('default_library') != 'static' + if host_machine.system() == 'windows' + config_h.set('DLL_EXPORT', true) + if cc.get_id() == 'msvc' + config_h.set('_MKS_EXTERN', '__declspec(dllexport) extern') + elif cc.has_argument('-fvisibility=hidden') + config_h.set('_MKS_EXTERN', '__attribute__((visibility("default"))) __declspec(dllexport) extern') + hidden_visibility_args = ['-fvisibility=hidden'] + endif + elif cc.has_argument('-fvisibility=hidden') + config_h.set('_MKS_EXTERN', '__attribute__((visibility("default"))) extern') + hidden_visibility_args = ['-fvisibility=hidden'] + endif +endif +project_c_args += hidden_visibility_args +add_project_arguments(project_c_args, language: 'c') + +release_args = [] +project_link_args = [] +test_link_args = [ + '-Wl,-z,relro', + '-Wl,-z,now', +] +if not get_option('buildtype').startswith('debug') + add_global_arguments(['-DG_DISABLE_CAST_CHECKS'], language: 'c') + release_args += [ '-DG_DISABLE_ASSERT' ] + test_link_args += [ + '-Wl,-Bsymbolic', + '-fno-plt', + ] +endif +foreach link_arg: test_link_args + if cc.has_link_argument(link_arg) + project_link_args += link_arg + endif +endforeach +add_project_link_arguments(project_link_args, language: 'c') + +subdir('lib') +subdir('tools') + +configure_file(output: 'config.h', configuration: config_h) \ No newline at end of file diff --git a/tools/meson.build b/tools/meson.build new file mode 100644 index 0000000..227bf41 --- /dev/null +++ b/tools/meson.build @@ -0,0 +1,9 @@ +tools = { + 'mks-connect': {}, +} + +foreach tool, params: tools + tool_exe = executable(tool, '@0@.c'.format(tool), + dependencies: libmks_dep, + ) +endforeach \ No newline at end of file diff --git a/tools/mks-connect.c b/tools/mks-connect.c new file mode 100644 index 0000000..635e4f9 --- /dev/null +++ b/tools/mks-connect.c @@ -0,0 +1,76 @@ +/* + * mks-connect.c + * + * Copyright 2023 Christian Hergert + * + * 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 . + * + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +#include "config.h" + +#include +#include + +#include +#include +#include + +int +main (int argc, + char *argv[]) +{ + g_autoptr(GOptionContext) context = g_option_context_new ("DBUS_ADDRESS - Connect to Qemu at DBUS_ADDRESS"); + g_autoptr(GDBusConnection) connection = NULL; + g_autoptr(MksSession) session = NULL; + g_autoptr(GError) error = NULL; + + setlocale (LC_ALL, ""); + bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8"); + + gtk_init (); + mks_init (); + + if (!g_option_context_parse (context, &argc, &argv, &error)) + { + g_printerr ("%s\n", error->message); + return EXIT_FAILURE; + } + + if (argc < 2) + connection = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &error); + else + connection = g_dbus_connection_new_for_address_sync (argv[1], 0, NULL, NULL, &error); + + if (connection == NULL) + { + g_printerr ("Failed to connect to D-Bus: %s\n", + error->message); + return EXIT_FAILURE; + } + + if (!(session = mks_session_new_for_connection_sync (connection, NULL, &error))) + { + g_printerr ("Failed to create MksSession: %s\n", + error->message); + return EXIT_FAILURE; + } + + g_print ("Session(uuid=\"%s\" name=\"%s\")\n", + mks_session_get_uuid (session), + mks_session_get_name (session)); + + return EXIT_SUCCESS; +}