commit c9af84442882c20528c021ecc08a9d49caa340e8 Author: ruinivist Date: Tue Feb 24 22:57:14 2026 +0000 init diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..25ed932 --- /dev/null +++ b/.clang-format @@ -0,0 +1,2 @@ +BasedOnStyle: Google +IndentWidth: 4 \ No newline at end of file diff --git a/.clangd b/.clangd new file mode 100644 index 0000000..bfcb0ba --- /dev/null +++ b/.clangd @@ -0,0 +1,3 @@ +CompileFlags: + # C++20 + Add: [-std=c++20] diff --git a/.githooks/pre-commit b/.githooks/pre-commit new file mode 100755 index 0000000..be47b3c --- /dev/null +++ b/.githooks/pre-commit @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +set -euo pipefail + +repo_root="$(git rev-parse --show-toplevel)" +cd "$repo_root" + +echo "[pre-commit] Running make format..." +make format + +echo "[pre-commit] Staging formatting changes..." +git add -A + +echo "[pre-commit] Running make lint..." +make lint diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..897cb7e --- /dev/null +++ b/.gitignore @@ -0,0 +1,27 @@ +# KDE / QT +.kdev4/ +*.kdev4 +.directory +*.user +*.pro.user +*.moc +*.o +*.obj +*.rcc +*.ui +*.qrc +.qmake.stash + +# Build artifacts +build/ +*.plasmoid +package/contents/ui/cppbridge/ + +# Temporary files +*~ +*.swp +*.bak +.DS_Store + +# Logs +*.log diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..cc42f68 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,11 @@ +{ + "overrides": [ + { + "files": "*.json", + "options": { + "tabWidth": 4, + "useTabs": false + } + } + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..f338cd7 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,16 @@ +{ + "cmake.sourceDirectory": "${workspaceFolder}/cpp", + "cmake.useCMakePresets": "always", + "cmake.configureOnOpen": true, + "C_Cpp.default.cppStandard": "c++20", + "C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools", + "C_Cpp.default.compileCommands": "${workspaceFolder}/build/cpp/compile_commands.json", + "clangd.arguments": ["--compile-commands-dir=${workspaceFolder}/build/cpp"], + "qt-qml.qmlls.enabled": true, + "qt-qml.qmlls.customExePath": "/usr/lib/qt6/bin/qmlls", + "qt-qml.qmlls.customArgs": [ + "-I/usr/lib/qt6/qml", + "-b${workspaceFolder}/build/cpp", + "-d/usr/share/doc/qt6" + ] +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + 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/Makefile b/Makefile new file mode 100644 index 0000000..f62880b --- /dev/null +++ b/Makefile @@ -0,0 +1,189 @@ +# Makefile for KDE 6 Plasma Widget Development + +# Variables +PACKAGE_DIR := package +METADATA_FILE := $(PACKAGE_DIR)/metadata.json +WIDGET_ID := $(shell grep -oP '"Id": "\K[^"]+' $(METADATA_FILE)) +BUILD_DIR := build +PLASMOID_FILE := $(WIDGET_ID).plasmoid +CPP_DIR := cpp +CPP_BUILD_DIR := $(BUILD_DIR)/cpp +CPP_MODULE_DIR := $(PACKAGE_DIR)/contents/ui/cppbridge + +# Default target +.PHONY: help +help: + @echo "KDE Plasma 6 Widget Developer Tools" + @echo "" + @echo "Usage:" + @echo " make dev Run widget in plasmoidviewer from local package (MODE=panel|desktop|hidpi)" + @echo " make watch Start Development Mode with Hot Reload" + @echo " make cpp-build Build the C++ QML bridge module" + @echo " make cpp-clean Remove C++ bridge build artifacts" + @echo " make install Install/upgrade widget in local Plasma package store" + @echo " make uninstall Remove widget from local system" + @echo " make package Build .plasmoid file for distribution" + @echo " make clean Remove build artifacts" + @echo " make format Format QML, C++, JSON, YAML, and Markdown files" + @echo " make lint Run non-mutating lint and formatting checks" + @echo " make hooks-install Configure Git to use versioned hooks from .githooks/" + +# Git Hooks +# Configure Git to use versioned hooks stored in this repository. +.PHONY: hooks-install +hooks-install: + git config core.hooksPath .githooks + @echo "Configured core.hooksPath=.githooks" + +# C++ Bridge Build Targets +# Generate CMake build files for the C++ QML bridge. +.PHONY: cpp-configure +cpp-configure: + mkdir -p $(CPP_BUILD_DIR) + cd $(CPP_DIR) && cmake --preset clang-default + +# Build the C++ QML bridge module binaries. +.PHONY: cpp-build +cpp-build: cpp-configure + cmake --build $(CPP_BUILD_DIR) + +# Remove C++ bridge build output and copied module artifacts. +.PHONY: cpp-clean +cpp-clean: + rm -rf $(CPP_BUILD_DIR) $(CPP_MODULE_DIR) + +# Testing Targets +# Run plasmoidviewer from the local package directory. +# Optional MODE values: panel, desktop, hidpi (omit MODE for default). +.PHONY: dev +dev: cpp-build + @mode="$(MODE)"; \ + case "$$mode" in \ + ""|default) \ + plasmoidviewer -a $(PACKAGE_DIR) ;; \ + panel) \ + plasmoidviewer -a $(PACKAGE_DIR) -l topedge -f horizontal ;; \ + desktop) \ + plasmoidviewer -a $(PACKAGE_DIR) -l floating -f planar ;; \ + hidpi) \ + QT_SCALE_FACTOR=2 plasmoidviewer -a $(PACKAGE_DIR) ;; \ + *) \ + echo "Invalid MODE='$$mode'. Allowed: panel, desktop, hidpi (or omit MODE)."; \ + exit 1 ;; \ + esac + +# Development Tools +# Start file watcher for iterative development and reload workflow. +.PHONY: watch +watch: cpp-build + ./scripts/watch.sh + +# Format all QML files in the package directory in-place. +.PHONY: format-qml +format-qml: + @command -v qmlformat >/dev/null 2>&1 || { echo "Missing required tool: qmlformat"; exit 1; } + find $(PACKAGE_DIR) -name "*.qml" -type f -exec qmlformat -i {} + + +# Format C/C++ source and header files with clang-format. +.PHONY: format-cpp +format-cpp: + @command -v clang-format >/dev/null 2>&1 || { echo "Missing required tool: clang-format"; exit 1; } + find $(CPP_DIR) -type f \( -name "*.c" -o -name "*.cc" -o -name "*.cpp" -o -name "*.h" -o -name "*.hh" -o -name "*.hpp" \) -exec clang-format -i {} + + +# Format JSON/YAML/Markdown files with prettier. +.PHONY: format-prettier +format-prettier: + @command -v prettier >/dev/null 2>&1 || { echo "Missing required tool: prettier"; exit 1; } + find . -type f \ + \( -name "*.json" -o -name "*.yml" -o -name "*.yaml" -o -name "*.md" -o -name ".prettierrc" \) \ + -not -path "./.git/*" \ + -not -path "./build/*" \ + -print0 | xargs -0 -r prettier --write + +# Run all formatting passes. +.PHONY: format +format: format-qml format-cpp format-prettier + +# Linting +# Check QML formatting without changing files. +.PHONY: lint-qml-format +lint-qml-format: + @command -v qmlformat >/dev/null 2>&1 || { echo "Missing required tool: qmlformat"; exit 1; } + @status=0; \ + find $(PACKAGE_DIR) -name "*.qml" -type f -print0 | \ + xargs -0 -r -I{} sh -c 'tmp_file="$$(mktemp)"; qmlformat "$$1" > "$$tmp_file"; if ! cmp -s "$$1" "$$tmp_file"; then echo "QML format mismatch: $$1"; rm -f "$$tmp_file"; exit 1; fi; rm -f "$$tmp_file"' _ {} || status=1; \ + if [ "$$status" -ne 0 ]; then \ + echo "Run 'make format-qml' to fix QML formatting."; \ + exit 1; \ + fi + +# Run semantic QML lint checks. +.PHONY: lint-qml +lint-qml: cpp-build + @command -v qmllint >/dev/null 2>&1 || { echo "Missing required tool: qmllint"; exit 1; } + find $(PACKAGE_DIR) -name "*.qml" -type f -print0 | xargs -0 -r qmllint + +# Check C/C++ formatting without changing files. +.PHONY: lint-cpp +lint-cpp: + @command -v clang-format >/dev/null 2>&1 || { echo "Missing required tool: clang-format"; exit 1; } + find $(CPP_DIR) -type f \( -name "*.c" -o -name "*.cc" -o -name "*.cpp" -o -name "*.h" -o -name "*.hh" -o -name "*.hpp" \) -print0 | xargs -0 -r clang-format --dry-run --Werror + +# Check JSON/YAML/Markdown formatting without changing files. +.PHONY: lint-prettier +lint-prettier: + @command -v prettier >/dev/null 2>&1 || { echo "Missing required tool: prettier"; exit 1; } + find . -type f \ + \( -name "*.json" -o -name "*.yml" -o -name "*.yaml" -o -name "*.md" -o -name ".prettierrc" \) \ + -not -path "./.git/*" \ + -not -path "./build/*" \ + -print0 | xargs -0 -r prettier --check + +# Run all lint and formatting checks. +.PHONY: lint +lint: lint-qml-format lint-qml lint-cpp lint-prettier + +# Installation +# Install/upgrade widget in local Plasma package store. +.PHONY: install +install: cpp-build + @if kpackagetool6 --type Plasma/Applet --show $(WIDGET_ID) >/dev/null 2>&1; then \ + echo "Upgrading existing package: $(WIDGET_ID)"; \ + kpackagetool6 --type Plasma/Applet --upgrade $(PACKAGE_DIR); \ + else \ + echo "Installing new package: $(WIDGET_ID)"; \ + kpackagetool6 --type Plasma/Applet --install $(PACKAGE_DIR); \ + fi + +# Upgrade an already installed widget package with local changes. +.PHONY: upgrade +upgrade: cpp-build + kpackagetool6 --type Plasma/Applet --upgrade $(PACKAGE_DIR) + +# Remove installed widget package from local system. +.PHONY: uninstall +uninstall: + @if kpackagetool6 --type Plasma/Applet --show $(WIDGET_ID) >/dev/null 2>&1; then \ + echo "Removing package registration: $(WIDGET_ID)"; \ + kpackagetool6 --type Plasma/Applet --remove $(WIDGET_ID); \ + else \ + echo "Package not registered: $(WIDGET_ID)"; \ + fi + +# Packaging +# Create distributable .plasmoid archive from current package contents. +.PHONY: package +package: cpp-build + mkdir -p $(BUILD_DIR) + rm -f $(BUILD_DIR)/$(PLASMOID_FILE) + + # Zip package contents + cd $(PACKAGE_DIR) && zip -r ../$(BUILD_DIR)/$(PLASMOID_FILE) . + + @echo "" + @echo "Package built at: $(BUILD_DIR)/$(PLASMOID_FILE)" + +# Delete all generated build artifacts for a clean workspace. +.PHONY: clean +clean: + rm -rf $(BUILD_DIR) $(CPP_MODULE_DIR) diff --git a/README.md b/README.md new file mode 100644 index 0000000..a0da536 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# katoclock + +Just a cat pointing you the time. Bootstrapped from my [kde-6-widget-starter](https://github.com/ruinivist/kde-6-widget-starter) + +# Install + +- clone the repo +- `make install` from repo root diff --git a/cpp/CMakeLists.txt b/cpp/CMakeLists.txt new file mode 100644 index 0000000..1dcee43 --- /dev/null +++ b/cpp/CMakeLists.txt @@ -0,0 +1,39 @@ +cmake_minimum_required(VERSION 3.23) +project(cppbridge LANGUAGES CXX) + +set(CMAKE_EXPORT_COMPILE_COMMANDS ON) + +find_package(Qt6 REQUIRED COMPONENTS Core Qml Quick) +find_package(OpenCV 4 REQUIRED COMPONENTS core imgcodecs imgproc) +qt_standard_project_setup(REQUIRES 6.5) + +qt_add_qml_module(cppbridgeplugin + URI cppbridge + VERSION 1.0 + OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/../package/contents/ui/cppbridge" + SOURCES + src/clockimageprovider.hpp + src/clockimageprovider.cpp + src/config.hpp + src/renderer.hpp + src/renderer.cpp + src/timebridge.h + src/timebridge.cpp +) + +target_include_directories(cppbridgeplugin PRIVATE + "${CMAKE_CURRENT_SOURCE_DIR}/src" + ${OpenCV_INCLUDE_DIRS} +) +target_link_libraries(cppbridgeplugin PRIVATE + Qt6::Core + Qt6::Qml + Qt6::Quick + opencv_core + opencv_imgcodecs + opencv_imgproc +) +set_target_properties(cppbridgeplugin PROPERTIES + CXX_STANDARD 20 + CXX_STANDARD_REQUIRED ON +) diff --git a/cpp/CMakePresets.json b/cpp/CMakePresets.json new file mode 100644 index 0000000..ba467d7 --- /dev/null +++ b/cpp/CMakePresets.json @@ -0,0 +1,28 @@ +{ + "version": 6, + "cmakeMinimumRequired": { + "major": 3, + "minor": 23, + "patch": 0 + }, + "configurePresets": [ + { + "name": "clang-default", + "displayName": "Clang Default", + "description": "Configure build/cpp with clang/clang++ and export compile commands.", + "generator": "Unix Makefiles", + "binaryDir": "${sourceDir}/../build/cpp", + "cacheVariables": { + "CMAKE_C_COMPILER": "clang", + "CMAKE_CXX_COMPILER": "clang++", + "CMAKE_EXPORT_COMPILE_COMMANDS": "ON" + } + } + ], + "buildPresets": [ + { + "name": "clang-default", + "configurePreset": "clang-default" + } + ] +} diff --git a/cpp/src/clockimageprovider.cpp b/cpp/src/clockimageprovider.cpp new file mode 100644 index 0000000..dbeedd6 --- /dev/null +++ b/cpp/src/clockimageprovider.cpp @@ -0,0 +1,32 @@ +#include "clockimageprovider.hpp" + +#include + +ClockImageProvider::ClockImageProvider() + : QQuickImageProvider(QQuickImageProvider::Image) {} + +QImage ClockImageProvider::requestImage(const QString&, QSize* size, + const QSize& requestedSize) { + QImage frame; + { + QMutexLocker locker(&mutex_); + frame = image_; + } + + if (size != nullptr) { + *size = frame.size(); + } + + if (!frame.isNull() && requestedSize.width() > 0 && + requestedSize.height() > 0) { + return frame.scaled(requestedSize, Qt::KeepAspectRatio, + Qt::SmoothTransformation); + } + + return frame; +} + +void ClockImageProvider::setImage(const QImage& image) { + QMutexLocker locker(&mutex_); + image_ = image; +} diff --git a/cpp/src/clockimageprovider.hpp b/cpp/src/clockimageprovider.hpp new file mode 100644 index 0000000..1a1a9e2 --- /dev/null +++ b/cpp/src/clockimageprovider.hpp @@ -0,0 +1,19 @@ +#pragma once + +#include +#include +#include + +class ClockImageProvider : public QQuickImageProvider { + public: + ClockImageProvider(); + + QImage requestImage(const QString& id, QSize* size, + const QSize& requestedSize) override; + + void setImage(const QImage& image); + + private: + QMutex mutex_; + QImage image_; +}; diff --git a/cpp/src/config.hpp b/cpp/src/config.hpp new file mode 100644 index 0000000..043d4ff --- /dev/null +++ b/cpp/src/config.hpp @@ -0,0 +1,21 @@ +#pragma once + +#include + +// file full of magic numbers +// most are hand tuned based on the cat image I have + +namespace Config { +const cv::Point2f CLOCK_CENTER(300.0f, 286.0f); + +const double HAND_SCALE = 0.22; +const double HOUR_HAND_SCALE = HAND_SCALE * 0.7; +const double MINUTE_HAND_SCALE = HAND_SCALE * 0.7; + +const cv::Point2f HOUR_HAND_PIVOT_FRACTION(0.126f, 0.502f); +const cv::Point2f MINUTE_HAND_PIVOT_FRACTION(0.101f, 0.488f); +// Asset convention: unrotated hand points right (+X). +// Clock convention: 12:00 points up (-Y), hence +90 degrees. +const double HAND_BASE_ANGLE_OFFSET = 90.0; + +} // namespace Config diff --git a/cpp/src/renderer.cpp b/cpp/src/renderer.cpp new file mode 100644 index 0000000..688d4e3 --- /dev/null +++ b/cpp/src/renderer.cpp @@ -0,0 +1,112 @@ +#include "renderer.hpp" + +#include +#include +#include + +#include "config.hpp" + +Renderer::Renderer() {} + +bool Renderer::load_assets(const std::string& bg_path, + const std::string& hour_hand_path, + const std::string& minute_hand_path) { + background_ = cv::imread(bg_path, cv::IMREAD_UNCHANGED); + if (background_.empty()) { + std::cerr << "failed to load background: " << bg_path << std::endl; + return false; + } + if (background_.channels() != 4) { + std::cerr << "expected rgba png for background"; + return false; + } + + // Load hands with alpha channel. + hour_hand_ = cv::imread(hour_hand_path, cv::IMREAD_UNCHANGED); + if (hour_hand_.empty()) { + std::cerr << "failed to load hour hand: " << hour_hand_path + << std::endl; + return false; + } + + minute_hand_ = cv::imread(minute_hand_path, cv::IMREAD_UNCHANGED); + if (minute_hand_.empty()) { + std::cerr << "failed to load minute hand: " << minute_hand_path + << std::endl; + return false; + } + + if (hour_hand_.channels() != 4 || minute_hand_.channels() != 4) { + std::cerr << "expected rgba png for hands" << std::endl; + return false; + } + + return true; +} + +cv::Mat Renderer::render(double hour_angle, double minute_angle) { + auto clock_to_cv_rotation = [](double clock_angle) { + return Config::HAND_BASE_ANGLE_OFFSET - clock_angle; + }; + + cv::Mat warped_hour = transform_hand( + hour_hand_, clock_to_cv_rotation(hour_angle), Config::HOUR_HAND_SCALE, + Config::HOUR_HAND_PIVOT_FRACTION); + cv::Mat warped_minute = transform_hand( + minute_hand_, clock_to_cv_rotation(minute_angle), + Config::MINUTE_HAND_SCALE, Config::MINUTE_HAND_PIVOT_FRACTION); + + cv::Mat keyframe = background_.clone(); + + // Layer order matters: hour underneath minute. + blend_overlay(keyframe, warped_hour); + blend_overlay(keyframe, warped_minute); + + return keyframe; +} + +cv::Mat Renderer::transform_hand(const cv::Mat& hand_sprite, double angle_deg, + double scale, + const cv::Point2f& pivot_fraction) { + cv::Mat oriented_sprite; + cv::flip(hand_sprite, oriented_sprite, 0); + + if (scale <= 0.0) { + return cv::Mat::zeros(background_.size(), CV_8UC4); + } + + cv::Point2f pivot(oriented_sprite.cols * pivot_fraction.x, + oriented_sprite.rows * pivot_fraction.y); + + cv::Mat rot_mat = cv::getRotationMatrix2D(pivot, angle_deg, scale); + rot_mat.at(0, 2) += Config::CLOCK_CENTER.x - pivot.x; + rot_mat.at(1, 2) += Config::CLOCK_CENTER.y - pivot.y; + + cv::Mat overlay = cv::Mat::zeros(background_.size(), CV_8UC4); + cv::warpAffine(oriented_sprite, overlay, rot_mat, background_.size(), + cv::INTER_CUBIC, cv::BORDER_CONSTANT, + cv::Scalar(0, 0, 0, 0)); + + return overlay; +} + +void Renderer::blend_overlay(cv::Mat& bg, const cv::Mat& fg) { + // Blend hand RGB onto background RGB using hand alpha + for (int y = 0; y < fg.rows; ++y) { + const cv::Vec4b* fg_ptr = fg.ptr(y); + cv::Vec4b* bg_ptr = bg.ptr(y); + + for (int x = 0; x < fg.cols; ++x) { + const cv::Vec4b& fg_pixel = fg_ptr[x]; + const double alpha = fg_pixel[3] / 255.0; + + if (alpha > 0.0) { + const cv::Vec4b bg_pixel = bg_ptr[x]; + for (int c = 0; c < 3; ++c) { + bg_ptr[x][c] = static_cast( + fg_pixel[c] * alpha + bg_pixel[c] * (1.0 - alpha)); + } + } + } + } +} diff --git a/cpp/src/renderer.hpp b/cpp/src/renderer.hpp new file mode 100644 index 0000000..8fb06a9 --- /dev/null +++ b/cpp/src/renderer.hpp @@ -0,0 +1,28 @@ +#pragma once + +#include +#include + +class Renderer { + public: + Renderer(); + + // Load assets from disk. Returns false if any fail to load. + bool load_assets(const std::string& bg_path, + const std::string& hour_hand_path, + const std::string& minute_hand_path); + + // Composites the hands onto the background at the given angles (degrees). + // Returns the result image. + cv::Mat render(double hour_angle, double minute_angle); + + private: + cv::Mat background_; + cv::Mat hour_hand_; + cv::Mat minute_hand_; + + // Helpers + cv::Mat transform_hand(const cv::Mat& hand_sprite, double angle_deg, + double scale, const cv::Point2f& pivot_fraction); + void blend_overlay(cv::Mat& bg, const cv::Mat& fg); +}; diff --git a/cpp/src/timebridge.cpp b/cpp/src/timebridge.cpp new file mode 100644 index 0000000..3037db3 --- /dev/null +++ b/cpp/src/timebridge.cpp @@ -0,0 +1,216 @@ +#include "timebridge.h" + +#include +#include +#include +#include + +#include "clockimageprovider.hpp" +#include "renderer.hpp" + +namespace { +constexpr int kMillisPerMinute = 60 * 1000; +} + +ClockBridge::ClockBridge(QObject* parent) : QObject(parent) { + updateTimer_.setSingleShot(true); + connect(&updateTimer_, &QTimer::timeout, this, + &ClockBridge::onUpdateTimerTimeout); +} + +ClockBridge::~ClockBridge() { + updateTimer_.stop(); + if (renderer_ != nullptr) { + delete renderer_; + renderer_ = nullptr; + } +} + +QString ClockBridge::imageSource() const { return imageSource_; } + +bool ClockBridge::ready() const { return ready_; } + +QString ClockBridge::errorString() const { return errorString_; } + +bool ClockBridge::initialize(const QUrl& bg, const QUrl& hour, + const QUrl& minute) { + updateTimer_.stop(); + initialized_ = false; + setReady(false); + + const QString bgPath = toLocalPath(bg); + const QString hourPath = toLocalPath(hour); + const QString minutePath = toLocalPath(minute); + if (bgPath.isEmpty() || hourPath.isEmpty() || minutePath.isEmpty()) { + setErrorString(QStringLiteral("Clock assets must be local file URLs.")); + return false; + } + + if (!ensureImageProvider()) { + return false; + } + + if (renderer_ == nullptr) { + renderer_ = new Renderer(); + } + + if (!renderer_->load_assets(bgPath.toStdString(), hourPath.toStdString(), + minutePath.toStdString())) { + setErrorString(QStringLiteral("Failed to load clock assets.")); + return false; + } + + initialized_ = true; + if (!renderForCurrentTime()) { + initialized_ = false; + return false; + } + + scheduleNextMinuteTick(); + return true; +} + +void ClockBridge::refreshNow() { + if (!initialized_) { + setErrorString(QStringLiteral("ClockBridge is not initialized.")); + setReady(false); + return; + } + + renderForCurrentTime(); + scheduleNextMinuteTick(); +} + +void ClockBridge::onUpdateTimerTimeout() { + if (!initialized_) { + return; + } + + renderForCurrentTime(); + scheduleNextMinuteTick(); +} + +bool ClockBridge::ensureImageProvider() { + if (imageProvider_ != nullptr) { + return true; + } + + QQmlEngine* engine = qmlEngine(this); + if (engine == nullptr) { + setErrorString(QStringLiteral("ClockBridge has no active QQmlEngine.")); + return false; + } + + providerId_ = QStringLiteral("catclock_%1") + .arg(QUuid::createUuid().toString(QUuid::Id128)); + if (engine->imageProvider(providerId_) != nullptr) { + setErrorString(QStringLiteral("Image provider ID collision.")); + return false; + } + + imageProvider_ = new ClockImageProvider(); + engine->addImageProvider(providerId_, imageProvider_); + return true; +} + +bool ClockBridge::renderForCurrentTime() { + if (renderer_ == nullptr || imageProvider_ == nullptr) { + setErrorString(QStringLiteral("ClockBridge is not initialized.")); + setReady(false); + return false; + } + + const QTime now = QTime::currentTime(); + const int minute = now.minute(); + const int hour = now.hour(); + + const double minuteAngle = minute * 6.0; + const double hourAngle = (hour % 12) * 30.0 + minute * 0.5; + + cv::Mat frame = renderer_->render(hourAngle, minuteAngle); + if (frame.empty()) { + setErrorString(QStringLiteral("Renderer returned an empty frame.")); + setReady(false); + return false; + } + + cv::Mat rgbaFrame; + cv::cvtColor(frame, rgbaFrame, cv::COLOR_BGRA2RGBA); + QImage image(rgbaFrame.data, rgbaFrame.cols, rgbaFrame.rows, + static_cast(rgbaFrame.step), QImage::Format_RGBA8888); + imageProvider_->setImage(image.copy()); + + setErrorString(QString()); + setReady(true); + bumpFrameRevision(); + return true; +} + +void ClockBridge::scheduleNextMinuteTick() { + if (!initialized_) { + return; + } + + const QTime now = QTime::currentTime(); + int delayMs = kMillisPerMinute - (now.second() * 1000 + now.msec()); + if (delayMs <= 0 || delayMs > kMillisPerMinute) { + delayMs = kMillisPerMinute; + } + + updateTimer_.start(delayMs); +} + +void ClockBridge::setReady(bool value) { + if (ready_ == value) { + return; + } + ready_ = value; + emit readyChanged(); +} + +void ClockBridge::setErrorString(const QString& value) { + if (errorString_ == value) { + return; + } + errorString_ = value; + emit errorStringChanged(); +} + +QString ClockBridge::toLocalPath(const QUrl& url) const { + if (url.isEmpty()) { + return QString(); + } + + if (url.isLocalFile()) { + return url.toLocalFile(); + } + + if (url.scheme().isEmpty()) { + return url.toString(); + } + + return QString(); +} + +QString ClockBridge::buildImageSource() const { + if (providerId_.isEmpty()) { + return QString(); + } + + return QStringLiteral("image://%1/frame?rev=%2") + .arg(providerId_) + .arg(frameRevision_); +} + +// to signal image inddeed changed even if the path is same +// we update revision +void ClockBridge::bumpFrameRevision() { + ++frameRevision_; + const QString nextSource = buildImageSource(); + if (imageSource_ == nextSource) { + return; + } + + imageSource_ = nextSource; + emit imageSourceChanged(); +} diff --git a/cpp/src/timebridge.h b/cpp/src/timebridge.h new file mode 100644 index 0000000..9ef18ae --- /dev/null +++ b/cpp/src/timebridge.h @@ -0,0 +1,59 @@ +#pragma once + +#include + +#include +#include +#include +#include + +class ClockImageProvider; +class Renderer; + +class ClockBridge : public QObject { + Q_OBJECT + QML_ELEMENT + Q_PROPERTY(QString imageSource READ imageSource NOTIFY imageSourceChanged) + Q_PROPERTY(bool ready READ ready NOTIFY readyChanged) + Q_PROPERTY(QString errorString READ errorString NOTIFY errorStringChanged) + + public: + explicit ClockBridge(QObject* parent = nullptr); + ~ClockBridge() override; + + QString imageSource() const; + bool ready() const; + QString errorString() const; + + Q_INVOKABLE bool initialize(const QUrl& bg, const QUrl& hour, + const QUrl& minute); + Q_INVOKABLE void refreshNow(); + + signals: + void imageSourceChanged(); + void readyChanged(); + void errorStringChanged(); + + private slots: + void onUpdateTimerTimeout(); + + private: + bool ensureImageProvider(); + bool renderForCurrentTime(); + void scheduleNextMinuteTick(); + void setReady(bool value); + void setErrorString(const QString& value); + QString toLocalPath(const QUrl& url) const; + QString buildImageSource() const; + void bumpFrameRevision(); + + Renderer* renderer_ = nullptr; + ClockImageProvider* imageProvider_ = nullptr; + QString providerId_; + QString imageSource_; + QString errorString_; + bool ready_ = false; + bool initialized_ = false; + int frameRevision_ = 0; + QTimer updateTimer_; +}; diff --git a/package/contents/config/config.qml b/package/contents/config/config.qml new file mode 100644 index 0000000..4451c41 --- /dev/null +++ b/package/contents/config/config.qml @@ -0,0 +1,11 @@ +import QtQuick +import org.kde.plasma.configuration + +ConfigModel { + ConfigCategory { + name: i18n("General") + icon: "configure" + source: "configGeneral.qml" + } + +} diff --git a/package/contents/config/main.xml b/package/contents/config/main.xml new file mode 100644 index 0000000..6958445 --- /dev/null +++ b/package/contents/config/main.xml @@ -0,0 +1,8 @@ + + + + + diff --git a/package/contents/ui/assets/background.png b/package/contents/ui/assets/background.png new file mode 100644 index 0000000..eb0655c Binary files /dev/null and b/package/contents/ui/assets/background.png differ diff --git a/package/contents/ui/assets/hand_hour.png b/package/contents/ui/assets/hand_hour.png new file mode 100644 index 0000000..14b84eb Binary files /dev/null and b/package/contents/ui/assets/hand_hour.png differ diff --git a/package/contents/ui/assets/hand_minute.png b/package/contents/ui/assets/hand_minute.png new file mode 100644 index 0000000..91cffc0 Binary files /dev/null and b/package/contents/ui/assets/hand_minute.png differ diff --git a/package/contents/ui/configGeneral.qml b/package/contents/ui/configGeneral.qml new file mode 100644 index 0000000..c4ebef7 --- /dev/null +++ b/package/contents/ui/configGeneral.qml @@ -0,0 +1,5 @@ +import QtQuick +import org.kde.kcmutils as KCM + +KCM.SimpleKCM { +} diff --git a/package/contents/ui/main.qml b/package/contents/ui/main.qml new file mode 100644 index 0000000..95f9c83 --- /dev/null +++ b/package/contents/ui/main.qml @@ -0,0 +1,83 @@ +import QtQuick +import QtQuick.Layouts +import "cppbridge" as CppBridge +import org.kde.kirigami as Kirigami +import org.kde.plasma.components as PlasmaComponents +import org.kde.plasma.core as PlasmaCore +import org.kde.plasma.plasmoid + +PlasmoidItem { + id: root + + // Widget setup + width: Kirigami.Units.gridUnit * 20 + height: Kirigami.Units.gridUnit * 20 + Plasmoid.backgroundHints: PlasmaCore.Types.NoBackground + toolTipMainText: "katoclock" + Component.onCompleted: { + const initialized = clockBridge.initialize(Qt.resolvedUrl("assets/background.png"), Qt.resolvedUrl("assets/hand_hour.png"), Qt.resolvedUrl("assets/hand_minute.png")); + if (!initialized) + console.warn(clockBridge.errorString); + + } + + CppBridge.ClockBridge { + id: clockBridge + } + + component ClockImageView: Item { + // asset image size -> 421x600, 1 is cropping artifact but I'll live with it + implicitWidth: 421 + implicitHeight: 600 + + Image { + anchors.fill: parent + visible: clockBridge.ready + source: clockBridge.imageSource + fillMode: Image.PreserveAspectFit + asynchronous: true + cache: false + } + + PlasmaComponents.Label { + anchors.fill: parent + visible: !clockBridge.ready + text: clockBridge.errorString.length > 0 ? clockBridge.errorString : "Loading..." + horizontalAlignment: Text.AlignHCenter + verticalAlignment: Text.AlignVCenter + wrapMode: Text.Wrap + } + + } + + // full representation (popup or desktop widget) + fullRepresentation: Item { + Layout.minimumWidth: Kirigami.Units.gridUnit * 12 + Layout.minimumHeight: Kirigami.Units.gridUnit * 12 + Layout.preferredWidth: root.width + Layout.preferredHeight: root.height + + ClockImageView { + anchors.fill: parent + anchors.margins: Kirigami.Units.smallSpacing + } + + } + + // compact representation (icon in panel) + compactRepresentation: Item { + Layout.minimumWidth: Kirigami.Units.gridUnit * 6 + Layout.minimumHeight: Kirigami.Units.gridUnit * 6 + + ClockImageView { + anchors.fill: parent + } + + MouseArea { + anchors.fill: parent + onClicked: root.expanded = !root.expanded + } + + } + +} diff --git a/package/metadata.json b/package/metadata.json new file mode 100644 index 0000000..876fab5 --- /dev/null +++ b/package/metadata.json @@ -0,0 +1,19 @@ +{ + "KPlugin": { + "Name": "KatoClock", + "Description": "Just a cat pointing you the time", + "Icon": "plasma", + "Category": "Development", + "Id": "katoclock.ruiny.de", + "Version": "1.0", + "Website": "https://github.com/ruinivist/katoclock", + "License": "GPL-3.0+", + "Authors": [ + { + "Name": "ruinivist" + } + ] + }, + "X-Plasma-API-Minimum-Version": "6.0", + "KPackageStructure": "Plasma/Applet" +} diff --git a/scripts/watch.sh b/scripts/watch.sh new file mode 100755 index 0000000..d230255 --- /dev/null +++ b/scripts/watch.sh @@ -0,0 +1,54 @@ +#!/bin/bash + +# Get the directory where the script is located +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +PACKAGE_DIR="$SCRIPT_DIR/package" +PLASMOID_NAME=$(grep -oP '"Id": "\K[^"]+' $PACKAGE_DIR/metadata.json) + +# Check for inotify-tools +if ! command -v inotifywait &> /dev/null; then + echo "Error: inotify-tools is typically not installed." + echo "Please install it with your package manager (e.g., sudo apt install inotify-tools)" + exit 1 +fi + +echo "Found Widget ID: $PLASMOID_NAME" +echo "Starting Hot Reload Watcher..." +echo "Press Ctrl+C to stop." + +# Cleanup function to kill the viewer when the script exits +cleanup() { + echo -e "\nStopping watcher..." + if [ -n "$PID" ]; then + kill $PID 2>/dev/null + fi + exit +} + +trap cleanup SIGINT SIGTERM + +# Initial start +echo -e "\n[$(date +%T)] Starting plasmoidviewer..." +plasmoidviewer -a $PACKAGE_DIR & +PID=$! + +# Watch loop +while true; do + # Wait for any file modification in the package directory + inotifywait -r -e modify -e create -e delete "$PACKAGE_DIR" -q + + echo -e "\n[$(date +%T)] Change detected! Reloading..." + + # Kill the current instance + if [ -n "$PID" ]; then + kill $PID 2>/dev/null + wait $PID 2>/dev/null + fi + + # Small delay to let Qt/KDE clean up properly + sleep 0.5 + + # Restart with absolute path + plasmoidviewer -a "$PACKAGE_DIR" & + PID=$! +done