diff --git a/.gitignore b/.gitignore index 9199e32a..9f24e2f8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,8 @@ /build/ /pkg/ -*~ \ No newline at end of file +*~ +.idea/ +.ts-for-gir.js +.vscode/ +jsconfig.json +@types/ \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 6181c425..00000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "code-runner.customCommand": "make vm_test" -} \ No newline at end of file diff --git a/LICENSE b/LICENSE index 2dc46eee..f288702d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License - -Copyright (c) 2021 Aurélien Hamy - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + 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 index af647f14..61e3d06b 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,15 @@ A GNOME Shell extension that adds a blur look to different parts of the GNOME Shell, including the top panel, dash and overview. -![Capture d’écran de 2021-04-21 23-59-06](https://user-images.githubusercontent.com/31563930/115626495-dc37c480-a2fd-11eb-8066-002dee4b5159.png) -*blurred top panel* -![Capture d’écran de 2021-04-21 23-59-11](https://user-images.githubusercontent.com/31563930/115626626-10ab8080-a2fe-11eb-89a5-7392cbe7c2f8.png) -*blurred overview* - [](https://extensions.gnome.org/extension/3193/blur-my-shell/) +## Screenshots + +*Blurred Overview:* +![Blurred Overview](https://user-images.githubusercontent.com/38633812/116588850-779beb80-a935-11eb-8f2f-81bcd46fe694.png) +*Blurred Top Panel:* +![Blurred Top Panel](https://user-images.githubusercontent.com/38633812/116588885-81bdea00-a935-11eb-9c80-c97716369b7c.png) + ## Known bugs ### Note @@ -17,16 +19,16 @@ This extension can be buggy, as the gnome-shell's blur implementation is quite f To entirely remove artifacts from the top panel, you can use static blur with the appropriate switch, **use static blur**. -Moreover, selecting *no artifacts* in the settings allows the blur to regenerate itself a lot better, at the expense of CPU time (adds ~3% CPU usage for the gnome-shell process in my old Thinkpad).\ -**note: in Gnome 40, selecting this option is not possible for the moment** +Moreover, if you don't use static blur, selecting *no artifacts* in the settings allows the blur to regenerate itself a lot better, at the expense of CPU time (but cannot currently tell the difference, less than 0.5% CPU on my middle-range i5) -Selecting another profile might be enought (especially if you have disabled animations), feel free to test! +Selecting another profile might be enough (especially if you have disabled animations and/or windows borders), feel free to test! ### List of bugs - artifacts on blurred parts [gnome shell bug](https://gitlab.gnome.org/GNOME/gnome-shell/-/issues/2857) - some apps may become transparent, a weird issue... -- cannot create rounded blur +- cannot create rounded blur (so no rounded dash-to-dock, or panel corners, ...) +- overview blur is transparent on second monitor when using Wayland, sometimes :( - etc (see in *issues*) If you find other bugs, please report them! @@ -45,16 +47,21 @@ make install And restart GNOME Shell if needed. +### Force overview blur update + +In case you have problems with your dynamic timed wallpaper not being updated due to using third-party process to change the wallpaper, you can force the overview blur to be updated with the command:\ +`gsettings set org.gnome.desktop.background picture-opacity 99 && gsettings set org.gnome.desktop.background picture-opacity 100` + ### Versions support -The current extension supports those GNOME Shell versions: +The current extension supports these GNOME Shell versions: - 40 -Older GNOME versions are supported up to Blur my Shell version 6: +Older GNOME Shell versions are supported up to Blur my Shell version 6, and by version 17: -- 3.36 - 3.38 +- 3.36 ## License diff --git a/src/appfolders.js b/src/appfolders.js new file mode 100644 index 00000000..157b1089 --- /dev/null +++ b/src/appfolders.js @@ -0,0 +1,229 @@ +'use strict'; + +const { Shell, GLib, Clutter } = imports.gi; +const Main = imports.ui.main; + +const Me = imports.misc.extensionUtils.getCurrentExtension(); +const Settings = Me.imports.settings; +const Utils = Me.imports.utilities; +const PaintSignals = Me.imports.paint_signals; + +const default_sigma = 30; +const default_brightness = 0.6; +const transparent = Clutter.Color.from_pixel(0x00000000); +const FOLDER_DIALOG_ANIMATION_TIME = 200; +const FRAME_UPDATE_PERIOD = 16; + +let original_zoomAndFadeIn = null; +let original_zoomAndFadeOut = null; +let sigma = default_sigma; +let brightness = default_brightness; + +let _zoomAndFadeIn = function () { + let [sourceX, sourceY] = + this._source.get_transformed_position(); + let [dialogX, dialogY] = + this.child.get_transformed_position(); + + this.child.set({ + translation_x: sourceX - dialogX, + translation_y: sourceY - dialogY, + scale_x: this._source.width / this.child.width, + scale_y: this._source.height / this.child.height, + opacity: 0, + }); + + this.set_background_color(transparent); + + let effect = this.get_effect("appfolder-blur"); + + effect.sigma = 0; + Utils.ease_property(effect, 'sigma', 0, sigma, FOLDER_DIALOG_ANIMATION_TIME, FRAME_UPDATE_PERIOD); + + effect.brightness = 1.0; + Utils.ease_property(effect, 'brightness', 1.0, brightness, FOLDER_DIALOG_ANIMATION_TIME, FRAME_UPDATE_PERIOD); + + this.child.ease({ + translation_x: 0, + translation_y: 0, + scale_x: 1, + scale_y: 1, + opacity: 255, + duration: FOLDER_DIALOG_ANIMATION_TIME, + mode: Clutter.AnimationMode.EASE_OUT_QUAD, + }); + + this._needsZoomAndFade = false; + + if (this._sourceMappedId === 0) { + this._sourceMappedId = this._source.connect( + 'notify::mapped', this._zoomAndFadeOut.bind(this)); + } +} + +let _zoomAndFadeOut = function () { + if (!this._isOpen) + return; + + if (!this._source.mapped) { + this.hide(); + return; + } + + let [sourceX, sourceY] = + this._source.get_transformed_position(); + let [dialogX, dialogY] = + this.child.get_transformed_position(); + + this.set_background_color(transparent); + + let effect = this.get_effect("appfolder-blur"); + + Utils.ease_property(effect, 'sigma', effect.sigma, 0, FOLDER_DIALOG_ANIMATION_TIME, FRAME_UPDATE_PERIOD); + + Utils.ease_property(effect, 'brightness', effect.brightness, 1.0, FOLDER_DIALOG_ANIMATION_TIME, FRAME_UPDATE_PERIOD); + + this.child.ease({ + translation_x: sourceX - dialogX, + translation_y: sourceY - dialogY, + scale_x: this._source.width / this.child.width, + scale_y: this._source.height / this.child.height, + opacity: 0, + duration: FOLDER_DIALOG_ANIMATION_TIME, + mode: Clutter.AnimationMode.EASE_OUT_QUAD, + onComplete: () => { + this.child.set({ + translation_x: 0, + translation_y: 0, + scale_x: 1, + scale_y: 1, + opacity: 255, + }); + this.hide(); + + this._popdownCallbacks.forEach(func => func()); + this._popdownCallbacks = []; + }, + }); + + this._needsZoomAndFade = false; +} + + +var AppFoldersBlur = class AppFoldersBlur { + constructor(connections, prefs) { + this.connections = connections; + this.paint_signals = new PaintSignals.PaintSignals(connections); + this.prefs = prefs; + } + + enable() { + this._log("blurring appfolders"); + + if (Main.overview._overview.controls._appDisplay._folderIcons.length > 0) { + this.blur_appfolders(); + } + this.connections.connect(Main.overview._overview.controls._appDisplay, 'view-loaded', () => { + this.blur_appfolders(); + }) + } + + blur_appfolders() { + Main.overview._overview.controls._appDisplay._folderIcons.forEach(icon => { + icon._ensureFolderDialog(); + + if (original_zoomAndFadeIn == null) { + original_zoomAndFadeIn = icon._dialog._zoomAndFadeIn; + } + if (original_zoomAndFadeOut == null) { + original_zoomAndFadeOut = icon._dialog._zoomAndFadeOut; + } + + let effect = new Shell.BlurEffect({ + name: "appfolder-blur", + sigma: sigma, + brightness: brightness, + mode: 1 + }); + icon._dialog.remove_effect_by_name("appfolder-blur"); + icon._dialog.add_effect(effect); + + // HACK + // ! DIRTY PART: hack because `Shell.BlurEffect` does not repaint when shadows are under it + // ! this does not entirely fix this bug (shadows caused by windows still cause artefacts) + // ! but it prevents the shadows of the panel buttons to cause artefacts on the panel itself + // ! note: issue opened at https://gitlab.gnome.org/GNOME/gnome-shell/-/issues/2857 + + if (this.prefs.HACKS_LEVEL.get() == 1) { + this._log("appfolders hack level 1"); + this.paint_signals.disconnect_all(); + + Utils.setTimeout(() => { + this.paint_signals.connect(Main.overview._overview, effect); + this.paint_signals.connect(icon._dialog, effect); + }, 100); + } else if (this.prefs.HACKS_LEVEL.get() == 2) { + this._log("panel hack level 2"); + this.paint_signals.disconnect_all(); + + Utils.setTimeout(() => { + this.paint_signals.connect(Main.overview._overview, effect); + this.paint_signals.connect(icon._dialog, effect); + }, 100); + } else { + this.paint_signals.disconnect_all(); + } + + // ! END OF DIRTY PART + + icon._dialog._viewBox.add_style_class_name('transparent-app-folder-dialogs'); + + icon._dialog._zoomAndFadeIn = _zoomAndFadeIn; + icon._dialog._zoomAndFadeOut = _zoomAndFadeOut; + }); + } + + set_sigma(s) { + sigma = s; + if (this.prefs.BLUR_APPFOLDERS.get()) + this.blur_appfolders(); + } + + set_brightness(b) { + brightness = b; + if (this.prefs.BLUR_APPFOLDERS.get()) + this.blur_appfolders(); + } + + disable() { + this._log("removing blur from appfolders"); + + if (original_zoomAndFadeIn != null) { + Main.overview._overview.controls._appDisplay._folderIcons.forEach(icon => { + if (icon._dialog) + icon._dialog._zoomAndFadeIn = original_zoomAndFadeIn; + }); + } + if (original_zoomAndFadeOut != null) { + Main.overview._overview.controls._appDisplay._folderIcons.forEach(icon => { + if (icon._dialog) + icon._dialog._zoomAndFadeOut = original_zoomAndFadeOut; + }); + } + Main.overview._overview.controls._appDisplay._folderIcons.forEach(icon => { + if (icon._dialog) { + icon._dialog.remove_effect_by_name("appfolder-blur") + icon._dialog._viewBox.remove_style_class_name('transparent-app-folder-dialogs'); + } + }); + + this._log(`before: ${this.connections.buffer}`) + this.connections.disconnect_all(); + this._log(`after: ${this.connections.buffer}`) + } + + _log(str) { + if (this.prefs.DEBUG.get()) + log(`[Blur my Shell] ${str}`) + } +} diff --git a/src/connections.js b/src/connections.js index ebaa32b7..9c02d5f1 100644 --- a/src/connections.js +++ b/src/connections.js @@ -30,7 +30,6 @@ var Connections = class Connections { connect(actor, signal, handler) { let id = actor.connect(signal, handler); - this.process_connection(actor, id); } @@ -40,6 +39,25 @@ var Connections = class Connections { this.process_connection(actor, id); } + disconnect_all_for(actor) { + let actor_connections = this.buffer.filter((infos) => { + infos.actor == actor + }); + + actor_connections.forEach((connection) => { + // disconnect + try { + connection.actor.disconnect(connection.id) + } catch (e) { + this._log(`error removing connection: ${e}; continuing`) + } + + // remove from buffer + let index = this.buffer.indexOf(connection); + this.buffer.splice(index, 1); + }) + } + disconnect_all() { this.buffer.forEach((connection) => { try { @@ -51,6 +69,7 @@ var Connections = class Connections { this.buffer = []; } + // no need to check if DEBUG here, the log function is only used on error _log(str) { log(`[Blur my Shell] ${str}`) } diff --git a/src/dash.js b/src/dash.js index 36cf68e7..d9872d26 100644 --- a/src/dash.js +++ b/src/dash.js @@ -5,14 +5,14 @@ const Main = imports.ui.main; const Me = imports.misc.extensionUtils.getCurrentExtension(); const Settings = Me.imports.settings; -let prefs = new Settings.Prefs; const default_sigma = 30; const default_brightness = 0.6; var DashBlur = class DashBlur { - constructor(connections) { + constructor(connections, prefs) { this.connections = connections; + this.prefs = prefs; } enable() { @@ -22,7 +22,7 @@ var DashBlur = class DashBlur { update() { if (Main.overview.dash.constructor.name == "Dash") { - Main.overview.dash.get_child_at_index(0).style = "background-color:rgba(0,0,0," + prefs.DASH_OPACITY.get() + ")"; + Main.overview.dash.get_child_at_index(0).style = "background-color:rgba(0,0,0," + this.prefs.DASH_OPACITY.get() + ")"; } } @@ -38,9 +38,12 @@ var DashBlur = class DashBlur { } } } + + this.connections.disconnect_all(); } _log(str) { - log(`[Blur my Shell] ${str}`) + if (this.prefs.DEBUG.get()) + log(`[Blur my Shell] ${str}`) } -} \ No newline at end of file +} diff --git a/src/dash_to_dock.js b/src/dash_to_dock.js index b791d3c5..1e4a03bd 100644 --- a/src/dash_to_dock.js +++ b/src/dash_to_dock.js @@ -6,26 +6,20 @@ const Signals = imports.signals; const Me = imports.misc.extensionUtils.getCurrentExtension(); const Settings = Me.imports.settings; -let prefs = new Settings.Prefs; +const Utils = Me.imports.utilities; +const PaintSignals = Me.imports.paint_signals; const default_sigma = 30; const default_brightness = 0.6; -// useful -const setTimeout = function (func, delay, ...args) { - return GLib.timeout_add(GLib.PRIORITY_DEFAULT, delay, () => { - func(...args); - return GLib.SOURCE_REMOVE; - }); -}; - class DashInfos { - constructor(dash_blur, dash, dash_box, background_parent, effect) { + constructor(dash_blur, dash, dash_box, background_parent, effect, prefs) { this.dash_blur = dash_blur; this.dash = dash; this.dash_box = dash_box; this.background_parent = background_parent; this.effect = effect; + this.prefs = prefs; dash_blur.connections.connect(dash_blur, 'remove-dashes', () => { this._log("removing blur from dash"); @@ -51,14 +45,17 @@ class DashInfos { } _log(str) { - log(`[Blur my Shell] ${str}`) + if (this.prefs.DEBUG.get()) + log(`[Blur my Shell] ${str}`) } } var DashBlur = class DashBlur { - constructor(connections) { + constructor(connections, prefs) { this.dashes = []; this.connections = connections; + this.prefs = prefs; + this.paint_signals = new PaintSignals.PaintSignals(connections); this.sigma = default_sigma; this.brightness = default_brightness; } @@ -97,6 +94,20 @@ var DashBlur = class DashBlur { let dash = dash_container.get_child_at_index(0).get_child_at_index(0).get_child_at_index(0); let dash_box = dash.get_child_at_index(0); + var adjustment = 0; + switch (dash_container._position) { + case 0: // top, dash to dock 40 PR has a bug where has space on top + adjustment = 8; + break; + case 1: // right + case 3: // left + adjustment = 16; + break; + case 2: // bottom + adjustment = 0; + break; + } + // the effect applied let effect = new Shell.BlurEffect({ brightness: this.brightness, @@ -117,16 +128,16 @@ var DashBlur = class DashBlur { let background = new St.Widget({ style_class: 'dash-blurred-background', x: dash_box.x, - y: dash.height - dash_box.height - 8, + y: dash.height - dash_box.height - adjustment, width: dash_box.width, height: dash_box.height, }); - setTimeout(() => { + Utils.setTimeout(() => { background.height = dash_box.height; background.width = dash_box.width; background.x = dash_box.x; - background.y = dash.height - dash_box.height - 8; + background.y = dash.height - dash_box.height - adjustment; }, 100); let dash_icons_container = dash.get_child_at_index(1).get_child_at_index(0).get_child_at_index(2); @@ -137,7 +148,7 @@ var DashBlur = class DashBlur { background.height = dash_box.height; background.width = dash_box.width; background.x = dash_box.x; - background.y = dash.height - dash_box.height - 8; + background.y = dash.height - dash_box.height - adjustment; }); // HACK @@ -147,25 +158,34 @@ var DashBlur = class DashBlur { // ! but it prevents the shadows of the dash buttons to cause artefacts on the dash itself // ! note: issue opened at https://gitlab.gnome.org/GNOME/gnome-shell/-/issues/2857 - if (prefs.HACKS_LEVEL.get() == 1) { + if (this.prefs.HACKS_LEVEL.get() == 1) { this._log("dash hack level 1"); + this.paint_signals.disconnect_all(); let rp = () => { effect.queue_repaint() }; dash_icons_container.get_children().forEach((icon) => { - let zone = icon.get_child_at_index(0); - this.connections.connect(zone, 'enter-event', rp); - this.connections.connect(zone, 'leave-event', rp); - this.connections.connect(zone, 'button-press-event', rp); + try { + let zone = icon.get_child_at_index(0); + this.connections.connect(zone, 'enter-event', rp); + this.connections.connect(zone, 'leave-event', rp); + this.connections.connect(zone, 'button-press-event', rp); + } catch (e) { + this._log(`${e}, continuing`); + } }) this.connections.connect(dash_icons_container, 'actor-added', (_, actor) => { - let zone = actor.get_child_at_index(0); - this.connections.connect(zone, 'enter-event', rp); - this.connections.connect(zone, 'leave-event', rp); - this.connections.connect(zone, 'button-press-event', rp); + try { + let zone = actor.get_child_at_index(0); + this.connections.connect(zone, 'enter-event', rp); + this.connections.connect(zone, 'leave-event', rp); + this.connections.connect(zone, 'button-press-event', rp); + } catch (e) { + this._log(`${e}, continuing`); + } }) let dash_show_apps = dash.get_child_at_index(1).get_child_at_index(1); @@ -175,17 +195,12 @@ var DashBlur = class DashBlur { this.connections.connect(dash_show_apps, 'button-press-event', rp); this.connections.connect(dash, 'leave-event', rp); - } else if (prefs.HACKS_LEVEL.get() == 2) { + } else if (this.prefs.HACKS_LEVEL.get() == 2) { this._log("dash hack level 2"); - let rp = () => { - effect.queue_repaint(); - }; - - // disabled because of #31 - /* - this.connections.connect(dash, 'paint', rp); - */ + this.paint_signals.connect(dash, this.effect); + } else { + this.paint_signals.disconnect_all(); } // ! END OF DIRTY PART @@ -196,17 +211,17 @@ var DashBlur = class DashBlur { background_parent.add_child(background); dash.get_parent().insert_child_at_index(background_parent, 0); dash_box.style = "background-color:rgba(0,0,0,0.0);"; - setTimeout(() => { + Utils.setTimeout(() => { dash_box.style = "background-color:rgba(0,0,0,0.0);"; Main.panel._leftCorner.hide(); Main.panel._rightCorner.hide(); }, 500); - setTimeout(() => { + Utils.setTimeout(() => { dash_box.style = "background-color:rgba(0,0,0,0.0);" }, 3000); // returns infos - return new DashInfos(this, dash, dash_box, background_parent, effect); + return new DashInfos(this, dash, dash_box, background_parent, effect, this.prefs); } set_sigma(sigma) { @@ -225,6 +240,7 @@ var DashBlur = class DashBlur { this.emit('remove-dashes', true); this.dashes = []; + this.connections.disconnect_all(); } show() { @@ -235,8 +251,9 @@ var DashBlur = class DashBlur { } _log(str) { - log(`[Blur my Shell] ${str}`) + if (this.prefs.DEBUG.get()) + log(`[Blur my Shell] ${str}`) } } -Signals.addSignalMethods(DashBlur.prototype); \ No newline at end of file +Signals.addSignalMethods(DashBlur.prototype); diff --git a/src/extension.js b/src/extension.js index e221e29c..6191b742 100644 --- a/src/extension.js +++ b/src/extension.js @@ -13,43 +13,56 @@ const Dash = Me.imports.dash; const Overview = Me.imports.overview; const DashToDock = Me.imports.dash_to_dock; const Lockscreen = Me.imports.lockscreen; +const AppFolders = Me.imports.appfolders; +const Keyboard = Me.imports.keyboard; class Extension { - constructor() { - this._connections = new Connections.Connections; - this._prefs = new Settings.Prefs; - - this._panel_blur = new Panel.PanelBlur(this._connections); - this._dash_blur = new Dash.DashBlur(this._connections); - this._dash_to_dock_blur = new DashToDock.DashBlur(this._connections); - this._overview_blur = new Overview.OverviewBlur(this._connections); - this._lockscreen_blur = new Lockscreen.LockscreenBlur(this._connections); - } + constructor() { } enable() { + this._prefs = new Settings.Prefs; + this._log("enabling extension..."); + this._connections = []; + + this._panel_blur = new Panel.PanelBlur(new Connections.Connections, this._prefs); + this._dash_blur = new Dash.DashBlur(new Connections.Connections, this._prefs); + this._dash_to_dock_blur = new DashToDock.DashBlur(new Connections.Connections, this._prefs); + this._overview_blur = new Overview.OverviewBlur(new Connections.Connections, this._prefs); + this._lockscreen_blur = new Lockscreen.LockscreenBlur(new Connections.Connections, this._prefs); + this._appfolders_blur = new AppFolders.AppFoldersBlur(new Connections.Connections, this._prefs); + this._keyboard_blur = new Keyboard.KeyboardBlur(new Connections.Connections, this._prefs); + + this._connections.push(this._panel_blur.connections, this._dash_blur.connections, + this._dash_to_dock_blur.connections, this._overview_blur.connections, + this._lockscreen_blur.connections, this._appfolders_blur.connections, + this._keyboard_blur.connections); this._connect_to_settings(); if (this._prefs.BLUR_PANEL.get()) { - this._panel_blur.enable() + this._panel_blur.enable(); } if (this._prefs.BLUR_DASH.get()) { this._dash_blur.enable(); this._dash_to_dock_blur.enable(); } if (this._prefs.BLUR_OVERVIEW.get()) { - this._overview_blur.enable() + this._overview_blur.enable(); } if (this._prefs.BLUR_LOCKSCREEN.get()) { - this._lockscreen_blur.enable() + this._lockscreen_blur.enable(); + } + if (this._prefs.BLUR_APPFOLDERS.get()) { + this._appfolders_blur.enable(); + } + if (this._prefs.BLUR_KEYBOARD.get()) { + this._keyboard_blur.enable(); } this._update_sigma(); this._update_brightness(); - this._connect_to_overview(); - this._log("extension enabled."); } @@ -61,19 +74,35 @@ class Extension { this._dash_to_dock_blur.disable(); this._overview_blur.disable(); this._lockscreen_blur.disable(); + this._appfolders_blur.disable(); + this._keyboard_blur.disable(); + + this._panel_blur = null; + this._dash_blur = null; + this._dash_to_dock_blur = null; + this._overview_blur = null; + this._lockscreen_blur = null; + this._appfolders_blur = null; + this._keyboard_blur = null; this._disconnect_settings(); - this._connections.disconnect_all(); + + this._connections.forEach((connections) => { + connections.disconnect_all(); + }) + this._connections = []; this._log("extension disabled."); + + this._prefs = null; } _connect_to_settings() { this._prefs.SIGMA.changed(() => { - this._update_sigma() + this._update_sigma(); }); this._prefs.BRIGHTNESS.changed(() => { - this._update_brightness() + this._update_brightness(); }); this._prefs.BLUR_DASH.changed(() => { @@ -87,30 +116,44 @@ class Extension { }); this._prefs.BLUR_PANEL.changed(() => { if (this._prefs.BLUR_PANEL.get()) { - this._panel_blur.enable() + this._panel_blur.enable(); } else { - this._panel_blur.disable() + this._panel_blur.disable(); } }); this._prefs.BLUR_OVERVIEW.changed(() => { if (this._prefs.BLUR_OVERVIEW.get()) { - this._overview_blur.enable() + this._overview_blur.enable(); } else { - this._overview_blur.disable() + this._overview_blur.disable(); } }); this._prefs.BLUR_LOCKSCREEN.changed(() => { if (this._prefs.BLUR_LOCKSCREEN.get()) { - this._lockscreen_blur.enable() + this._lockscreen_blur.enable(); + } else { + this._lockscreen_blur.disable(); + } + }); + this._prefs.BLUR_APPFOLDERS.changed(() => { + if (this._prefs.BLUR_APPFOLDERS.get()) { + this._appfolders_blur.enable(); } else { - this._lockscreen_blur.disable() + this._appfolders_blur.disable(); + } + }); + this._prefs.BLUR_KEYBOARD.changed(() => { + if (this._prefs.BLUR_KEYBOARD.get()) { + this._keyboard_blur.enable(); + } else { + this._keyboard_blur.disable(); } }); this._prefs.DASH_OPACITY.changed(() => { - this._dash_blur.update() + this._dash_blur.update(); }); this._prefs.STATIC_BLUR.changed(() => { - this._panel_blur.change_blur_type() + this._panel_blur.change_blur_type(); }); } @@ -126,6 +169,8 @@ class Extension { this._dash_to_dock_blur.set_sigma(sigma); this._overview_blur.set_sigma(sigma); this._lockscreen_blur.set_sigma(sigma); + this._appfolders_blur.set_sigma(sigma); + this._keyboard_blur.set_sigma(sigma); } _update_brightness() { @@ -135,26 +180,18 @@ class Extension { this._dash_to_dock_blur.set_brightness(brightness); this._overview_blur.set_brightness(brightness); this._lockscreen_blur.set_brightness(brightness); - } - - _connect_to_overview() { - this._connections.connect(Main.overview, 'showing', () => { - this._panel_blur.hide(); - //this._dash_to_dock_blur.hide(); - }); - this._connections.connect(Main.overview, 'hidden', () => { - this._panel_blur.show(); - //this._dash_to_dock_blur.show(); - }); + this._appfolders_blur.set_brightness(brightness); + this._keyboard_blur.set_brightness(brightness); } _log(str) { - log(`[Blur my Shell] ${str}`) + if (this._prefs.DEBUG.get()) + log(`[Blur my Shell] ${str}`) } -}; +} // Called on gnome-shell loading, even if extension is deactivated function init() { return new Extension(); -} \ No newline at end of file +} diff --git a/src/keyboard.js b/src/keyboard.js new file mode 100644 index 00000000..8fa2dce5 --- /dev/null +++ b/src/keyboard.js @@ -0,0 +1,88 @@ +'use strict'; + +const { St, Shell, Meta, Gio, GLib } = imports.gi; +const Main = imports.ui.main; + +const Me = imports.misc.extensionUtils.getCurrentExtension(); +const Settings = Me.imports.settings; +const Utils = Me.imports.utilities; +const PaintSignals = Me.imports.paint_signals; + + +var KeyboardBlur = class KeyboardBlur { + constructor(connections, prefs) { + this.connections = connections; + this.paint_signals = new PaintSignals.PaintSignals(connections); + this.prefs = prefs; + this.sigma = this.prefs.SIGMA.get(); + this.brightness = this.prefs.BRIGHTNESS.get(); + this.first_blurred = false; + } + + enable() { + this._log("blurring keyboard"); + + this.connections.connect(Main.uiGroup, "actor-added", (_, actor) => { + this.init_blur(); + }); + + this.init_blur(); + } + + init_blur() { + if (!this.first_blurred && Main.layoutManager.keyboardBox) { + this.connections.connect(Main.layoutManager.keyboardBox, 'show', () => { + Utils.setTimeout(() => { this.blur_keyboard(); }, 100); + }); + this.connections.connect(Main.layoutManager.keyboardBox, 'hide', () => { + Utils.setTimeout(() => { this.unblur_keyboard(); }, 100); + }); + this.first_blurred = true; + }; + } + + blur_keyboard() { + let effect = new Shell.BlurEffect({ + name: "keyboard-blur", + sigma: this.sigma, + brightness: this.brightness, + mode: 1 + }); + Main.layoutManager.keyboardBox.get_child_at_index(0).add_effect(effect); + this.paint_signals.connect(Main.layoutManager.keyboardBox.get_child_at_index(0), effect); + Main.layoutManager.keyboardBox.get_child_at_index(0).style = "background:transparent;"; + } + + unblur_keyboard() { + this.paint_signals.disconnect_all(); + try { + Main.layoutManager.keyboardBox.get_child_at_index(0).remove_effect_by_name("keyboard-blur"); + } catch (e) { } + } + + set_sigma(s) { + this.sigma = s; + } + + set_brightness(b) { + this.brightness = b; + } + + disable() { + this._log("removing blur from keyboard"); + + this.connections.disconnect_all(); + } + + show() { + this.background_parent.show(); + } + hide() { + this.background_parent.hide(); + } + + _log(str) { + if (this.prefs.DEBUG.get()) + log(`[Blur my Shell] ${str}`) + } +} diff --git a/src/lockscreen.js b/src/lockscreen.js index 1c9cc2e8..c7df275e 100644 --- a/src/lockscreen.js +++ b/src/lockscreen.js @@ -4,71 +4,40 @@ const { St, Shell } = imports.gi; const Main = imports.ui.main; const Background = imports.ui.background; -const themeContext = St.ThemeContext.get_for_stage(global.stage); - let sigma = 30; let brightness = 0.6; const original_createBackground = imports.ui.unlockDialog.UnlockDialog.prototype._updateBackgroundEffects; var LockscreenBlur = class LockscreenBlur { - constructor(connections) { + constructor(connections, prefs) { this.connections = connections; + this.prefs = prefs; } enable() { this._log("blurring lockscreen"); - this.update_lockscreen() + this.update_lockscreen(); } update_lockscreen() { imports.ui.unlockDialog.UnlockDialog.prototype._updateBackgroundEffects = this._createBackground; } - _createBackground() { - for (const widget of this._backgroundGroup.get_children()) { - widget.get_effect('blur').set({ - brightness: brightness, - sigma: sigma * themeContext.scale_factor, - }); + for (const widget of this._backgroundGroup) { + const effect = widget.get_effect('blur'); + + if (effect) { + effect.set({ + brightness: brightness, + sigma: sigma, + }); + } } } - _createBackground_old(monitorIndex) { - let monitor = Main.layoutManager.monitors[monitorIndex]; - let widget = new St.Widget({ - style_class: 'screen-shield-background', - x: monitor.x, - y: monitor.y, - width: monitor.width, - height: monitor.height, - }); - - let bgManager = new Background.BackgroundManager({ - container: widget, - monitorIndex, - controlPosition: false, - }); - - this._bgManagers.push(bgManager); - - this._backgroundGroup.add_child(widget); - - let effect = new Shell.BlurEffect({ - brightness: brightness, - sigma: sigma * themeContext.scale_factor, - mode: 0 - }); - - this._scaleChangedId = themeContext.connect('notify::scale-factor', () => { - effect.sigma = sigma * themeContext.scale_factor; - }); - - widget.add_effect(effect); - } - set_sigma(s) { sigma = s; this.update_lockscreen(); @@ -83,9 +52,12 @@ var LockscreenBlur = class LockscreenBlur { this._log("removing blur from lockscreen"); imports.ui.unlockDialog.UnlockDialog.prototype._updateBackgroundEffects = original_createBackground; + + this.connections.disconnect_all(); } _log(str) { - log(`[Blur my Shell] ${str}`) + if (this.prefs.DEBUG.get()) + log(`[Blur my Shell] ${str}`) } -} \ No newline at end of file +} diff --git a/src/overview.js b/src/overview.js index ed100579..e2137621 100644 --- a/src/overview.js +++ b/src/overview.js @@ -1,28 +1,23 @@ 'use strict'; -const { Shell, GLib, Gio, Meta } = imports.gi; +const { Shell, Gio, Meta } = imports.gi; const Main = imports.ui.main; const backgroundSettings = new Gio.Settings({ schema: 'org.gnome.desktop.background' }); const Me = imports.misc.extensionUtils.getCurrentExtension(); const Settings = Me.imports.settings; -let prefs = new Settings.Prefs; - -// useful -const setTimeout = function (func, delay, ...args) { - return GLib.timeout_add(GLib.PRIORITY_DEFAULT, delay, () => { - func(...args); - return GLib.SOURCE_REMOVE; - }); -}; +const Utils = Me.imports.utilities; const default_sigma = 30; const default_brightness = 0.6; +let sigma = default_sigma; + var OverviewBlur = class OverviewBlur { - constructor(connections) { + constructor(connections, prefs) { this.connections = connections; this.effects = []; + this.prefs = prefs; } enable() { @@ -30,25 +25,27 @@ var OverviewBlur = class OverviewBlur { this.connections.connect(backgroundSettings, 'changed', () => { this._log("updated background"); - setTimeout(() => { this.update_backgrounds() }, 100); + Utils.setTimeout(() => { this.update_backgrounds() }, 100); }); this.connections.connect(Main.layoutManager, 'monitors-changed', () => { if (!Main.screenShield.locked) { this._log("changed monitors"); - this.update_backgrounds() + this.update_backgrounds(); } }); this.update_backgrounds(); + Utils.setTimeout(() => { this.update_backgrounds() }, 500); } update_backgrounds() { // remove every old background Main.layoutManager.overviewGroup.get_children().forEach(actor => { if (actor.constructor.name == 'Meta_BackgroundActor') { - Main.layoutManager.overviewGroup.remove_child(actor) - }; + Main.layoutManager.overviewGroup.remove_child(actor); + actor.destroy(); + } this.effects = []; }); @@ -58,8 +55,8 @@ var OverviewBlur = class OverviewBlur { let background = Main.layoutManager._backgroundGroup.get_child_at_index(Main.layoutManager.monitors.length - monitor.index - 1); bg_actor.set_content(background.get_content()); let effect = new Shell.BlurEffect({ - brightness: prefs.BRIGHTNESS.get(), - sigma: prefs.SIGMA.get(), + brightness: this.prefs.BRIGHTNESS.get(), + sigma: this.prefs.SIGMA.get(), mode: 0 }); bg_actor.add_effect(effect); @@ -74,13 +71,14 @@ var OverviewBlur = class OverviewBlur { set_sigma(s) { this.effects.forEach(effect => { - effect.sigma = s + effect.sigma = s; }); + sigma = s; } set_brightness(b) { this.effects.forEach(effect => { - effect.brightness = b + effect.brightness = b; }); } @@ -91,10 +89,12 @@ var OverviewBlur = class OverviewBlur { Main.layoutManager.overviewGroup.remove_child(actor) } }); - this.effects = [] + this.effects = []; + this.connections.disconnect_all(); } _log(str) { - log(`[Blur my Shell] ${str}`) + if (this.prefs.DEBUG.get()) + log(`[Blur my Shell] ${str}`) } -} \ No newline at end of file +} diff --git a/src/paint_signals.js b/src/paint_signals.js new file mode 100644 index 00000000..bc574104 --- /dev/null +++ b/src/paint_signals.js @@ -0,0 +1,51 @@ +'use strict' + +const { GObject, Clutter } = imports.gi; + +var PaintSignals = class PaintSignals { + constructor(connections) { + this.buffer = []; + this.connections = connections + } + + connect(actor, blur_effect) { + let paint_effect = new EmitPaintSignal(); + let infos = { + actor: actor, + paint_effect: paint_effect + }; + + actor.add_effect(paint_effect); + this.connections.connect(paint_effect, 'update-blur', () => { + blur_effect.queue_repaint(); + }); + + this.buffer.push(infos) + } + + disconnect_all() { + this.buffer.forEach((infos) => { + this.connections.disconnect_all_for(infos.paint_effect); + infos.actor.remove_effect(infos.paint_effect); + }); + + this.buffer = [] + } +} + +var EmitPaintSignal = GObject.registerClass( + { + GTypeName: 'EmitPaintSignal', + Signals: { + 'update-blur': { + param_types: [] + }, + } + }, + class EmitPaintSignal extends Clutter.Effect { + vfunc_paint(node, paint_context, paint_flags) { + this.emit("update-blur"); + super.vfunc_paint(node, paint_context, paint_flags); + } + } +); diff --git a/src/panel.js b/src/panel.js index 8249db0d..6eebf705 100644 --- a/src/panel.js +++ b/src/panel.js @@ -6,28 +6,27 @@ const backgroundSettings = new Gio.Settings({ schema: 'org.gnome.desktop.backgro const Me = imports.misc.extensionUtils.getCurrentExtension(); const Settings = Me.imports.settings; -let prefs = new Settings.Prefs; +const Utils = Me.imports.utilities; +const PaintSignals = Me.imports.paint_signals; +const dash_to_panel_uuid = 'dash-to-panel@jderose9.github.com'; const default_sigma = 30; const default_brightness = 0.6; -// useful -const setTimeout = function (func, delay, ...args) { - return GLib.timeout_add(GLib.PRIORITY_DEFAULT, delay, () => { - func(...args); - return GLib.SOURCE_REMOVE; - }); -}; +let sigma = 30; var PanelBlur = class PanelBlur { - constructor(connections) { + constructor(connections, prefs) { this.connections = connections; + this.paint_signals = new PaintSignals.PaintSignals(connections); + this.prefs = prefs; this.effect = new Shell.BlurEffect({ brightness: default_brightness, sigma: default_sigma, mode: prefs.STATIC_BLUR.get() ? 0 : 1 }); this.background_parent = new St.Widget({ + name: 'topbar-blurred-background-parent', style_class: 'topbar-blurred-background-parent', x: this.monitor.x, y: this.monitor.y, @@ -48,7 +47,11 @@ var PanelBlur = class PanelBlur { this._log("blurring top panel"); // insert background parent - Main.panel.get_parent().insert_child_at_index(this.background_parent, 0); + let children = Main.layoutManager.panelBox.get_children(); + for (let i = 0; i < children.length; ++i) + if (children[i].name == 'topbar-blurred-background-parent') + Main.layoutManager.panelBox.remove_child(children[i]); + Main.layoutManager.panelBox.insert_child_at_index(this.background_parent, 0); // hide corners, can't style them Main.panel._leftCorner.hide(); Main.panel._rightCorner.hide(); @@ -57,22 +60,31 @@ var PanelBlur = class PanelBlur { // perform updates this.change_blur_type(); + Utils.setTimeout(() => { this.change_blur_type() }, 500); // connect to size, monitor or wallpaper changes this.connections.connect(Main.panel, 'notify::height', () => { - this.update_size(prefs.STATIC_BLUR.get()); + this.update_size(this.prefs.STATIC_BLUR.get()); }); this.connections.connect(Main.layoutManager, 'monitors-changed', () => { - this.update_wallpaper(prefs.STATIC_BLUR.get()); - this.update_size(prefs.STATIC_BLUR.get()); + this.update_wallpaper(this.prefs.STATIC_BLUR.get()); + this.update_size(this.prefs.STATIC_BLUR.get()); }); this.connections.connect(backgroundSettings, 'changed', () => { - setTimeout(() => { this.update_wallpaper(prefs.STATIC_BLUR.get()) }, 100); + Utils.setTimeout(() => { this.update_wallpaper(this.prefs.STATIC_BLUR.get()) }, 100); + }); + + // connect to overview + this.connections.connect(Main.overview, 'showing', () => { + this.hide(); + }); + this.connections.connect(Main.overview, 'hidden', () => { + this.show(); }); } change_blur_type() { - let is_static = prefs.STATIC_BLUR.get(); + let is_static = this.prefs.STATIC_BLUR.get(); this.background_parent.remove_child(this.background); this.background.remove_effect(this.effect); @@ -97,8 +109,9 @@ var PanelBlur = class PanelBlur { // ! but it prevents the shadows of the panel buttons to cause artefacts on the panel itself // ! note: issue opened at https://gitlab.gnome.org/GNOME/gnome-shell/-/issues/2857 - if (prefs.HACKS_LEVEL.get() == 1) { + if (this.prefs.HACKS_LEVEL.get() == 1) { this._log("panel hack level 1"); + this.paint_signals.disconnect_all(); let rp = () => { this.effect.queue_repaint() @@ -113,17 +126,16 @@ var PanelBlur = class PanelBlur { this.connections.connect(child, 'leave-event', rp); this.connections.connect(child, 'button-press-event', rp); }); - } else if (prefs.HACKS_LEVEL.get() == 2) { + } else if (this.prefs.HACKS_LEVEL.get() == 2) { this._log("panel hack level 2"); + this.paint_signals.disconnect_all(); - // disabled because of #31 - /* + this.paint_signals.connect(Main.panel, this.effect); Main.panel.get_children().forEach(child => { - this.connections.connect(child, 'paint', () => { - this.effect.queue_repaint(); - }); + this.paint_signals.connect(child, this.effect); }); - */ + } else { + this.paint_signals.disconnect_all(); } // ! END OF DIRTY PART @@ -132,27 +144,48 @@ var PanelBlur = class PanelBlur { update_wallpaper(is_static) { if (is_static) { - let bg = Main.layoutManager._backgroundGroup.get_child_at_index(this.monitor.index); + let bg = Main.layoutManager._backgroundGroup.get_child_at_index(Main.layoutManager.monitors.length - this.monitor.index - 1); this.background.set_content(bg.get_content()); } } update_size(is_static) { - this.background_parent.width = this.monitor.width; - this.background.width = this.monitor.width; + this.background_parent.width = Main.panel.width; + this.background.width = Main.panel.width; this.background.height = Main.panel.height; + let panel_box = Main.layoutManager.panelBox; + let clip_box = panel_box.get_parent(); if (is_static) { this.background.set_clip( - this.monitor.x, - this.monitor.y, - this.monitor.width, - Main.panel.height + clip_box.x, + clip_box.y, + panel_box.width, + panel_box.height ); + this.background.x = -clip_box.x; + this.background.y = -clip_box.y; } } + _connect_to_dash_to_panel() { + this.connections.connect(Main.extensionManager, 'extension-state-changed', (data, extension) => { + if (extension.uuid === dash_to_panel_uuid/* && extension.state === 1*/) { + this._log("Dash to Panel detected, resetting panel blur"); + Utils.setTimeout(() => { + this.disable(); + this.enable(); + }, 300); + } + }); + } + get monitor() { - return Main.layoutManager.primaryMonitor + if (Main.layoutManager.primaryMonitor != null) { + return Main.layoutManager.primaryMonitor + } + else { + return { x: 0, y: 0, width: 0, index: 0 } + } } set_sigma(s) { @@ -165,14 +198,15 @@ var PanelBlur = class PanelBlur { disable() { this._log("removing blur from top panel"); - Main.panel._leftCorner.show(); Main.panel._rightCorner.show(); Main.panel.remove_style_class_name('transparent-panel'); try { - this.background_parent.get_parent().remove_child(this.background_parent); + Main.layoutManager.panelBox.remove_child(this.background_parent); } catch (e) { } + + this.connections.disconnect_all(); } show() { @@ -183,6 +217,7 @@ var PanelBlur = class PanelBlur { } _log(str) { - log(`[Blur my Shell] ${str}`) + if (this.prefs.DEBUG.get()) + log(`[Blur my Shell] ${str}`) } -} \ No newline at end of file +} diff --git a/src/prefs.js b/src/prefs.js index ce736774..cc3f6bfc 100644 --- a/src/prefs.js +++ b/src/prefs.js @@ -7,8 +7,8 @@ const Extension = ExtensionUtils.getCurrentExtension(); let Settings = Extension.imports.settings; let config = new Settings.Prefs(); -const PrefsWidget = GObject.registerClass({ - GTypeName: 'PrefsWidget', +const BlurMyShellPrefsWidget = GObject.registerClass({ + GTypeName: 'BlurMyShellPrefsWidget', Template: Extension.dir.get_child('prefs.ui').get_uri(), InternalChildren: [ 'sigma_scale', @@ -17,13 +17,16 @@ const PrefsWidget = GObject.registerClass({ 'blur_panel', 'blur_overview', 'blur_lockscreen', + 'blur_appfolders', + 'blur_keyboard', 'hacks_level0', 'hacks_level1', 'hacks_level2', 'dash_opacity_scale', - 'static_blur' + 'static_blur', + 'debug_mode' ], -}, class PrefsWidget extends Gtk.Box { +}, class BlurMyShellPrefsWidget extends Gtk.Box { _init(params = {}) { super._init(params); @@ -45,6 +48,12 @@ const PrefsWidget = GObject.registerClass({ // ! blur lockscreen this._blur_lockscreen.set_active(config.BLUR_LOCKSCREEN.get()); + // ! blur appfolders + this._blur_appfolders.set_active(config.BLUR_APPFOLDERS.get()); + + // ! blur keyboard + this._blur_keyboard.set_active(config.BLUR_KEYBOARD.get()); + // ! dash hacks if (config.HACKS_LEVEL.get() == 0) { this._hacks_level0.set_active(true); @@ -65,6 +74,9 @@ const PrefsWidget = GObject.registerClass({ // ! static panel blur this._static_blur.set_active(config.STATIC_BLUR.get()); + + // ! debug mode + this._debug_mode.set_active(config.DEBUG.get()); } sigma_changed(w) { @@ -97,6 +109,16 @@ const PrefsWidget = GObject.registerClass({ config.BLUR_LOCKSCREEN.set(value); } + blur_appfolders_toggled(w) { + let value = w.get_active(); + config.BLUR_APPFOLDERS.set(value); + } + + blur_keyboard_toggled(w) { + let value = w.get_active(); + config.BLUR_KEYBOARD.set(value); + } + hacks_level0_toggled(w) { let is_active = w.get_active(); if (is_active) { config.HACKS_LEVEL.set(0) } @@ -117,18 +139,24 @@ const PrefsWidget = GObject.registerClass({ config.DASH_OPACITY.set(value); } - static_blur_toogled(w) { + static_blur_toggled(w) { let value = w.get_active(); config.STATIC_BLUR.set(value); } + debug_mode_toggled(w) { + let value = w.get_active(); + config.DEBUG.set(value); + } + _log(str) { - log(`[Blur my Shell] ${str}`) + if (config.DEBUG.get()) + log(`[Blur my Shell] ${str}`) } }); function init() { } function buildPrefsWidget() { - return new PrefsWidget(); -} \ No newline at end of file + return new BlurMyShellPrefsWidget(); +} diff --git a/src/prefs.ui b/src/prefs.ui index 482c3f7d..38e4d94b 100644 --- a/src/prefs.ui +++ b/src/prefs.ui @@ -1,7 +1,7 @@ -