commit 0434c13cf9c5f25234e75e1faffd81c5791ea32c Author: miruka Date: Thu Mar 21 23:28:14 2019 -0400 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..c25f1fc4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +__pycache__ +build +dist +*.egg-info +*.pyc +*.qmlc + +.pylintrc + +tmp-* diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/COPYING @@ -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 00000000..46408c3e --- /dev/null +++ b/Makefile @@ -0,0 +1,47 @@ +# Copyright 2019 miruka +# This file is part of harmonyqml, licensed under GPLv3. + +PKG_DIR = harmonyqml + +PYTHON = python3 +PIP = pip3 +PYLINT = pylint +CLOC = cloc + +ARCHIVE_FORMATS = gztar +INSTALL_FLAGS = --user --editable +PYLINT_FLAGS = --output-format colorized +CLOC_FLAGS = --ignore-whitespace + +.PHONY: all clean dist install upload test + + +all: clean dist install + +clean: + find . -name '__pycache__' -exec rm -Rfv {} + + find . -name '*.pyc' -exec rm -Rfv {} + + find . -name '*.qmlc' -exec rm -Rfv {} + + find . -name '*.egg-info' -exec rm -Rfv {} + + rm -Rfv build dist + +dist: clean + @echo + ${PYTHON} setup.py sdist --format ${ARCHIVE_FORMATS} + @echo + ${PYTHON} setup.py bdist_wheel + +install: clean + @echo + ${PIP} install ${INSTALL_FLAGS} . + + +upload: dist + @echo + twine upload dist/* + + +test: + - ${PYLINT} ${PYLINT_FLAGS} ${PKG_DIR} *.py + @echo + ${CLOC} ${CLOC_FLAGS} ${PKG_DIR} diff --git a/README.md b/README.md new file mode 100644 index 00000000..97f60d5f --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# harmonyqml + +[![PyPI downloads](http://pepy.tech/badge/harmonyqml)]( + http://pepy.tech/project/harmonyqml) +[![PyPI version](https://img.shields.io/pypi/v/harmonyqml.svg)]( + https://pypi.org/projects/harmonyqml) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/harmonyqml.svg)]( + https://pypi.python.org/pypi/harmonyqml) + + + + +## CLI examples + +```sh + $ harmonyqml +``` + +## Python package examples + +```python3 + >>> import harmonyqml + + >>> +``` + +## Installation + +Requires Python 3.6+, tested on GNU/Linux only. + +```sh + # pip3 install harmonyqml +``` diff --git a/TODO.md b/TODO.md new file mode 100644 index 00000000..277cc02f --- /dev/null +++ b/TODO.md @@ -0,0 +1 @@ +- diff --git a/harmonyqml/AccountDelegate.qml b/harmonyqml/AccountDelegate.qml new file mode 100644 index 00000000..992ee8dd --- /dev/null +++ b/harmonyqml/AccountDelegate.qml @@ -0,0 +1,43 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.0 +import QtQuick.Layouts 1.4 + +Rectangle { + readonly property string displayName: + Backend.getUser(section).display_name + + color: "#111" + width: roomListView.width + height: childrenRect.height + + RowLayout { + id: row + spacing: 1 + width: parent.width + + Avatar { id: avatar; username: displayName } + + ColumnLayout { + spacing: 1 + + PlainLabel { + id: accountLabel + text: displayName + color: "#CCC" + elide: Text.ElideRight + maximumLineCount: 1 + Layout.fillWidth: true + } + TextField { + id: statusEdit + placeholderText: qsTr("Set status message") + background: Rectangle { color: "#333" } + color: "#CCC" + selectByMouse: true + font.family: "Roboto" + font.pixelSize: 12 + Layout.fillWidth: true + } + } + } +} diff --git a/harmonyqml/Avatar.qml b/harmonyqml/Avatar.qml new file mode 100644 index 00000000..dcebde85 --- /dev/null +++ b/harmonyqml/Avatar.qml @@ -0,0 +1,40 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.0 +import QtQuick.Layouts 1.4 + +Item { + property bool invisible: false + property string username: "?" + property var imageSource: null + property int dimmension: 48 + + id: root + width: dimmension + height: invisible ? 1 : dimmension + + Rectangle { + id: letterRectangle + anchors.fill: parent + visible: ! invisible && imageSource === null + color: Qt.hsla(Backend.hueFromString(username), 0.22, 0.5, 1) + + PlainLabel { + anchors.centerIn: parent + text: username.charAt(0) + color: "white" + font.pixelSize: letterRectangle.height / 1.4 + } + } + + Image { + id: avatarImage + anchors.fill: parent + visible: ! invisible && imageSource !== null + + Component.onCompleted: if (imageSource) {source = imageSource} + asynchronous: true + mipmap: true + fillMode: Image.PreserveAspectCrop + sourceSize.width: root.dimmension + } +} diff --git a/harmonyqml/ChatPage.qml b/harmonyqml/ChatPage.qml new file mode 100644 index 00000000..33bf3064 --- /dev/null +++ b/harmonyqml/ChatPage.qml @@ -0,0 +1,15 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.2 +import QtQuick.Layouts 1.4 + +ColumnLayout { + property var room: null + + id: chatPage + spacing: 0 + onFocusChanged: sendBox.setFocus() + + RoomHeader {} + MessageDisplay {} + SendBox { id: sendBox } +} diff --git a/harmonyqml/DaybreakDelegate.qml b/harmonyqml/DaybreakDelegate.qml new file mode 100644 index 00000000..76b4e312 --- /dev/null +++ b/harmonyqml/DaybreakDelegate.qml @@ -0,0 +1,11 @@ +import QtQuick 2.7 + +PlainLabel { + text: date_time.toLocaleDateString() + width: rootCol.width + horizontalAlignment: Text.AlignHCenter + topPadding: rootCol.isFirstMessage ? 0 : rootCol.verticalPadding * 4 + bottomPadding: rootCol.verticalPadding * 2 + font.pixelSize: normalSize * 1.1 + color: "darkolivegreen" +} diff --git a/harmonyqml/DummyMessageModel.qml b/harmonyqml/DummyMessageModel.qml new file mode 100644 index 00000000..f9274a89 --- /dev/null +++ b/harmonyqml/DummyMessageModel.qml @@ -0,0 +1,54 @@ +import QtQuick 2.7 + +ListModel { + ListElement { + user_id: "@runi:matrix.org" + name: "Runi" + content: "Lorem ipsum" + date: "2019-03-10" + time: "19:41:10" + } + ListElement { + user_id: "@runi:matrix.org" + name: "Runi" + content: "Combine test?" + date: "2019-03-10" + time: "19:41:12" + } + ListElement { + user_id: "@mary:matrix.org" + name: "Mary" + content: "sit dolor amet" + date: "2019-03-10" + time: "19:42:10" + } + ListElement { + user_id: "@runi:matrix.org" + name: "Runi but a very long name test lorem ipsum foo bar flour orange water test" + content: "blah blah" + date: "2019-03-10" + time: "19:43:57" + } + ListElement { + user_id: "@runi:matrix.org" + name: "Runi" + content: "Long message text wxall of text jsqdjlfjlsdjf 1234 zaekfpozekf lorem ipsum foo bar 123 zfjhozj aazaazazaz fdefzef" + date: "2019-03-10" + time: "19:44:10" + } + ListElement { + user_id: "@renko:matrix.org" + name: "Renko" + content: "Baaaar." + date: "2019-03-10" + time: "19:44:22" + } + + ListElement { + user_id: "@runi:matrix.org" + name: "Runi" + content: "Test new day" + date: "2019-03-11" + time: "10:10:47" + } +} diff --git a/harmonyqml/DummyRoomModel.qml b/harmonyqml/DummyRoomModel.qml new file mode 100644 index 00000000..80afab75 --- /dev/null +++ b/harmonyqml/DummyRoomModel.qml @@ -0,0 +1,35 @@ +import QtQuick 2.7 + +ListModel { + ListElement { + account: "Runi" + room_name: "Maribel" + description: "This is a test ellide" + } + ListElement { + account: "Runi" + room_name: "Renko" + description: "Away" + } + ListElement { + account: "Runi" + room_name: "Moonlight" + description: "lorem ispum" + } + ListElement { + account: "Runi" + room_name: "test long abc def" + description: "WWWWWW WWWWWW WWWW WWWWWW WWWW" + } + + ListElement { + account: "Maribel" + room_name: "Maribel" + description: "This is a test ellide" + } + ListElement { + account: "Maribel" + room_name: "Moonlight" + description: "lorem ispum" + } +} diff --git a/harmonyqml/HMouseArea.qml b/harmonyqml/HMouseArea.qml new file mode 100644 index 00000000..cae30141 --- /dev/null +++ b/harmonyqml/HMouseArea.qml @@ -0,0 +1,5 @@ +import QtQuick 2.7 + +MouseArea { + cursorShape: Qt.PointingHandCursor +} diff --git a/harmonyqml/HomePage.qml b/harmonyqml/HomePage.qml new file mode 100644 index 00000000..2af21f6e --- /dev/null +++ b/harmonyqml/HomePage.qml @@ -0,0 +1,8 @@ +import QtQuick 2.7 + +Rectangle { + PlainLabel { + anchors.centerIn: parent + text: "Placeholder home page" + } +} diff --git a/harmonyqml/MessageDelegate.qml b/harmonyqml/MessageDelegate.qml new file mode 100644 index 00000000..2706ed12 --- /dev/null +++ b/harmonyqml/MessageDelegate.qml @@ -0,0 +1,106 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.0 +import QtQuick.Layouts 1.4 + +Column { + id: rootCol + + function mins_between(date1, date2) { + return Math.round((((date2 - date1) % 86400000) % 3600000) / 60000) + } + + readonly property string displayName: + Backend.getUser(sender_id).display_name + + readonly property bool isOwn: + chatPage.room.account_id === sender_id + + readonly property var previousData: + index > 0 ? messageListView.model.get(index - 1) : null + + readonly property bool isFirstMessage: ! previousData + + readonly property bool combine: + ! isFirstMessage && + previousData.sender_id == sender_id && + mins_between(previousData.date_time, date_time) <= 5 + + readonly property bool dayBreak: + isFirstMessage || + previousData.date_time.getDay() != date_time.getDay() + + readonly property bool talkBreak: + ! isFirstMessage && + ! dayBreak && + mins_between(previousData.date_time, date_time) >= 20 + + + property int standardSpacing: 8 + property int horizontalPadding: 7 + property int verticalPadding: 5 + + width: parent.width + topPadding: + previousData === null ? 0 : + talkBreak ? standardSpacing * 6 : + combine ? standardSpacing / 2 : + standardSpacing * 1.2 + + DaybreakDelegate { visible: dayBreak } + + + Row { + id: row + spacing: standardSpacing + layoutDirection: isOwn ? Qt.RightToLeft : Qt.LeftToRight + anchors.right: isOwn ? parent.right : undefined + + Avatar { id: avatar; invisible: combine; username: displayName } + + ColumnLayout { + spacing: 0 + + PlainLabel { + visible: ! combine + id: nameLabel + text: displayName + background: Rectangle {color: "#DDD"} + color: isOwn ? "teal" : "purple" + elide: Text.ElideRight + maximumLineCount: 1 + Layout.preferredWidth: contentLabel.width + horizontalAlignment: isOwn ? Text.AlignRight : Text.AlignLeft + + leftPadding: horizontalPadding + rightPadding: horizontalPadding + topPadding: verticalPadding + } + + PlainLabel { + id: contentLabel + //text: (isOwn ? "" : content + "  ") + + //"" + + //Qt.formatDateTime(date_time, "hh:mm:ss") + + //"" + + // (isOwn ? "  " + content : "") + + text: content + + "  " + + Qt.formatDateTime(date_time, "hh:mm:ss") + + "" + textFormat: Text.RichText + background: Rectangle {color: "#DDD"} + wrapMode: Text.Wrap + + leftPadding: horizontalPadding + rightPadding: horizontalPadding + bottomPadding: verticalPadding + + Layout.minimumWidth: nameLabel.implicitWidth + Layout.maximumWidth: Math.min( + 600, messageListView.width - avatar.width - row.spacing + ) + } + } + } +} diff --git a/harmonyqml/MessageDisplay.qml b/harmonyqml/MessageDisplay.qml new file mode 100644 index 00000000..34431c1a --- /dev/null +++ b/harmonyqml/MessageDisplay.qml @@ -0,0 +1,24 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.2 +import QtQuick.Layouts 1.4 + +Rectangle { + property int space: 8 + + Layout.fillWidth: true + Layout.fillHeight: true + Layout.leftMargin: space + Layout.rightMargin: space + + ListView { + id: messageListView + anchors.fill: parent + model: Backend.messagesModel[chatPage.room.room_id] + delegate: MessageDelegate {} + //highlight: Rectangle {color: "lightsteelblue"; radius: 5} + + clip: true + topMargin: space + bottomMargin: space + } +} diff --git a/harmonyqml/PlainLabel.qml b/harmonyqml/PlainLabel.qml new file mode 100644 index 00000000..4b17bf0c --- /dev/null +++ b/harmonyqml/PlainLabel.qml @@ -0,0 +1,12 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.0 + +Label { + property int bigSize: 22 + property int normalSize: 16 + property int smallSize: 12 + + font.family: "Roboto" + font.pixelSize: normalSize + textFormat: Text.PlainText +} diff --git a/harmonyqml/RoomDelegate.qml b/harmonyqml/RoomDelegate.qml new file mode 100644 index 00000000..1f1200f7 --- /dev/null +++ b/harmonyqml/RoomDelegate.qml @@ -0,0 +1,49 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.0 +import QtQuick.Layouts 1.4 + +Item { + width: roomListView.width + height: avatar.height + + RowLayout { + anchors.fill: parent + id: row + spacing: 1 + + Avatar { id: avatar; username: display_name } + + ColumnLayout { + spacing: 0 + + PlainLabel { + id: roomLabel + text: display_name + padding: 5 + bottomPadding: subtitleLabel.visible ? 0 : padding + elide: Text.ElideRight + maximumLineCount: 1 + Layout.maximumWidth: row.width - row.spacing - avatar.width + verticalAlignment: Qt.AlignVCenter + } + PlainLabel { + id: subtitleLabel + visible: text !== "" + text: subtitle + padding: roomLabel.padding + topPadding: 0 + font.pixelSize: smallSize + elide: Text.ElideRight + maximumLineCount: 1 + Layout.maximumWidth: roomLabel.Layout.maximumWidth + } + } + + Item { Layout.fillWidth: true } + } + + HMouseArea { + anchors.fill: parent + onClicked: pageStack.show_room(roomListView.model.get(index)) + } +} diff --git a/harmonyqml/RoomHeader.qml b/harmonyqml/RoomHeader.qml new file mode 100644 index 00000000..163ed355 --- /dev/null +++ b/harmonyqml/RoomHeader.qml @@ -0,0 +1,40 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.2 +import QtQuick.Layouts 1.4 + +Rectangle { + id: root + Layout.fillWidth: true + Layout.minimumHeight: avatar.height + Layout.maximumHeight: Layout.minimumHeight + color: "#BBB" + + Row { + id: "row" + spacing: 8 + + Avatar { id: "avatar"; username: chatPage.room.display_name } + + Column { + PlainLabel { + height: subtitleLabel.visible ? implicitHeight : row.height + id: "roomName" + text: chatPage.room.display_name + font.pixelSize: bigSize + elide: Text.ElideRight + maximumLineCount: 1 + width: root.width - avatar.width - row.spacing * 2 + verticalAlignment: Qt.AlignVCenter + } + PlainLabel { + id: subtitleLabel + text: chatPage.room.subtitle + visible: text !== "" + font.pixelSize: smallSize + elide: Text.ElideRight + maximumLineCount: 1 + width: roomName.width + } + } + } +} diff --git a/harmonyqml/RoomPane.qml b/harmonyqml/RoomPane.qml new file mode 100644 index 00000000..5967219b --- /dev/null +++ b/harmonyqml/RoomPane.qml @@ -0,0 +1,21 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.2 +import QtQuick.Layouts 1.4 + +Rectangle { + id: roomPane + Layout.preferredWidth: 150 + Layout.fillHeight: true + color: "gray" + + ListView { + id: roomListView + anchors.fill: parent + model: Backend.roomsModel + delegate: RoomDelegate {} + //highlight: Rectangle {color: "lightsteelblue"; radius: 5} + + section.property: "account_id" + section.delegate: AccountDelegate {} + } +} diff --git a/harmonyqml/SendBox.qml b/harmonyqml/SendBox.qml new file mode 100644 index 00000000..13af47c1 --- /dev/null +++ b/harmonyqml/SendBox.qml @@ -0,0 +1,60 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.2 +import QtQuick.Layouts 1.4 + +Rectangle { + function setFocus() { textArea.forceActiveFocus() } + + id: "root" + Layout.fillWidth: true + Layout.minimumHeight: textArea.implicitHeight + // parent.height / 2 causes binding loop? + Layout.maximumHeight: pageStack.height / 2 + color: "#BBB" + + RowLayout { + anchors.fill: parent + spacing: 0 + + Avatar { + id: "avatar" + username: Backend.getUser(chatPage.room.account_id).display_name + dimmension: root.Layout.minimumHeight + visible: textArea.text === "" + } + + ScrollView { + Layout.fillHeight: true + Layout.fillWidth: true + id: sendBoxScrollView + clip: true + + TextArea { + id: textArea + placeholderText: qsTr("Type a message...") + wrapMode: TextEdit.Wrap + selectByMouse: true + font.family: "Roboto" + font.pixelSize: 16 + focus: true + + Keys.onReturnPressed: { + event.accepted = true + + if (event.modifiers & Qt.ShiftModifier || + event.modifiers & Qt.ControlModifier || + event.modifiers & Qt.AltModifier) { + textArea.insert(textArea.cursorPosition, "\n") + return + } + + Backend.sendMessage(chatPage.room.account_id, + chatPage.room.room_id, + textArea.text) + textArea.clear() + } + Keys.onEnterPressed: Keys.onReturnPressed(event) // numpad enter + } + } + } +} diff --git a/harmonyqml/ToolTipLabel.qml b/harmonyqml/ToolTipLabel.qml new file mode 100644 index 00000000..3127fcd6 --- /dev/null +++ b/harmonyqml/ToolTipLabel.qml @@ -0,0 +1,16 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.0 + +PlainLabel { + id: text + ToolTip { + delay: Qt.styleHints.mousePressAndHoldInterval + visible: text ? toolTipZone.containsMouse : false + text: user_id + } + MouseArea { + id: toolTipZone + anchors.fill: parent + hoverEnabled: true + } +} diff --git a/harmonyqml/UI.qml b/harmonyqml/UI.qml new file mode 100644 index 00000000..89ddca61 --- /dev/null +++ b/harmonyqml/UI.qml @@ -0,0 +1,28 @@ +import QtQuick.Controls 2.2 +import QtQuick.Layouts 1.4 + +RowLayout { + anchors.fill: parent + spacing: 0 + + RoomPane {} + + StackView { + function show_room(room_obj) { + pageStack.replace("ChatPage.qml", { room: room_obj }) + } + + id: "pageStack" + Layout.fillWidth: true + Layout.fillHeight: true + //initialItem: HomePage {} + initialItem: ChatPage { room: Backend.roomsModel.get(0) } + + onCurrentItemChanged: currentItem.forceActiveFocus() + + // Buggy + replaceExit: null + popExit: null + pushExit: null + } +} diff --git a/harmonyqml/Window.qml b/harmonyqml/Window.qml new file mode 100644 index 00000000..4d64a420 --- /dev/null +++ b/harmonyqml/Window.qml @@ -0,0 +1,15 @@ +import QtQuick 2.7 +import QtQuick.Controls 2.2 + +ApplicationWindow { + visible: true + width: 640 + height: 700 + title: "Harmony QML" + + Loader { + anchors.fill: parent + source: "UI.qml" + objectName: "UILoader" + } +} diff --git a/harmonyqml/__about__.py b/harmonyqml/__about__.py new file mode 100644 index 00000000..5bc361d3 --- /dev/null +++ b/harmonyqml/__about__.py @@ -0,0 +1,14 @@ +# Copyright 2019 miruka +# This file is part of harmonyqml, licensed under GPLv3. + +"""""" + +__pkg_name__ = "harmonyqml" +__version__ = "0.1.0" +__status__ = "Development" +# __status__ = "Production" + +__author__ = "miruka" +__email__ = "miruka@disroot.org" + +__license__ = "GPLv3" diff --git a/harmonyqml/__init__.py b/harmonyqml/__init__.py new file mode 100644 index 00000000..da0c4393 --- /dev/null +++ b/harmonyqml/__init__.py @@ -0,0 +1,63 @@ +# Copyright 2019 miruka +# This file is part of harmonyqml, licensed under GPLv3. + +import logging +import os +import sys +from typing import Optional + +from PyQt5.QtCore import ( + QFileSystemWatcher, QMetaObject, QObject, QTimer, pyqtSlot +) +from PyQt5.QtGui import QGuiApplication +from PyQt5.QtQml import QQmlApplicationEngine, qmlRegisterType + +from .__about__ import __doc__ +from .backend import DummyBackend + +# logging.basicConfig(level=logging.INFO) + + +class Engine(QQmlApplicationEngine): + def __init__(self, app: QGuiApplication, parent: Optional[QObject] = None + ) -> None: + super().__init__(parent) + self.app = app + self.backend = DummyBackend() + self.program_dir = os.path.dirname(os.path.realpath(sys.argv[0])) + + # Set QML properties + self.rootContext().setContextProperty("Engine", self) + self.rootContext().setContextProperty("Backend", self.backend) + + # Connect Qt signals + self.quit.connect(self.app.quit) + + # Make SIGINT (ctrl-c) work + self._sigint_timer = QTimer() + self._sigint_timer.timeout.connect(lambda: None) + self._sigint_timer.start(100) + + # Setup UI live-reloading when a file is edited + self.file_watcher = QFileSystemWatcher() + self.file_watcher.directoryChanged.connect(lambda _: self.reload_qml()) + self.file_watcher.addPath(self.program_dir) + + # Load QML page and show window + self.load(os.path.join(self.program_dir, "Window.qml")) + self.rootObjects()[0].show() + sys.exit(self.app.exec()) + + + def reload_qml(self) -> None: + self.clearComponentCache() + loader = self.rootObjects()[0].findChild(QObject, "UILoader") + source = loader.property("source") + loader.setProperty("source", None) + loader.setProperty("source", source) + logging.info("Reloaded: %s", source) + + +def run() -> None: + app = QGuiApplication(sys.argv) + _ = Engine(app) # need to keep a reference diff --git a/harmonyqml/__main__.py b/harmonyqml/__main__.py new file mode 100644 index 00000000..9df3fc30 --- /dev/null +++ b/harmonyqml/__main__.py @@ -0,0 +1,8 @@ +# Copyright 2019 miruka +# This file is part of harmonyqml, licensed under GPLv3. + +"Run app when this package is executed from 'python -m '." + +from . import run + +run() diff --git a/harmonyqml/backend/__init__.py b/harmonyqml/backend/__init__.py new file mode 100644 index 00000000..838c7f35 --- /dev/null +++ b/harmonyqml/backend/__init__.py @@ -0,0 +1,5 @@ +# Copyright 2019 miruka +# This file is part of harmonyqml, licensed under GPLv3. + + +from .dummy import DummyBackend diff --git a/harmonyqml/backend/base.py b/harmonyqml/backend/base.py new file mode 100644 index 00000000..da3c1cdf --- /dev/null +++ b/harmonyqml/backend/base.py @@ -0,0 +1,89 @@ +# Copyright 2019 miruka +# This file is part of harmonyqml, licensed under GPLv3. + +import hashlib +from typing import Any, DefaultDict, Dict, NamedTuple, Optional + +from PyQt5.QtCore import QDateTime, QObject, pyqtProperty, pyqtSlot + +from .enums import Activity, MessageKind, Presence +from .list_model import ListModel, _QtListModel + + +class User(NamedTuple): + user_id: str + display_name: str + avatar_url: Optional[str] = None + + +class Room(NamedTuple): + account_id: str + room_id: str + display_name: str + subtitle: str = "" + unread_messages: int = 0 + presence: Presence = Presence.none + activity: Activity = Activity.none + last_activity_timestamp_ms: Optional[int] = None + avatar_url: Optional[str] = None + + +class Message(NamedTuple): + sender_id: str + date_time: QDateTime + content: str + kind: MessageKind = MessageKind.text + sender_avatar: Optional[str] = None + + +class Backend(QObject): + def __init__(self) -> None: + super().__init__() + self._known_users: Dict[str, User] = {} + + self.rooms: ListModel = ListModel() + self.messages: DefaultDict[str, ListModel] = DefaultDict(ListModel) + + + @pyqtProperty(_QtListModel, constant=True) + def roomsModel(self) -> _QtListModel: + return self.rooms.qt_model + + + @pyqtProperty("QVariantMap", constant=True) + def messagesModel(self) -> Dict[str, _QtListModel]: + return {room_id: l.qt_model for room_id, l in self.messages.items()} + + + @pyqtSlot(str, str, str) + def sendMessage(self, sender_id: str, room_id: str, markdown: str) -> None: + self.localEcho(sender_id, room_id, markdown) + self.sendToServer(sender_id, room_id, markdown) + + + def localEcho(self, sender_id: str, room_id: str, html: str) -> None: + self.messages[room_id].append(Message( + sender_id, QDateTime.currentDateTime(), html, + )) + + + def sendToServer(self, sender_id: str, room_id: str, html: str) -> None: + pass + + + @pyqtSlot(str, result="QVariantMap") + def getUser(self, user_id: str) -> Dict[str, Any]: + try: + return self._known_users[user_id]._asdict() + except KeyError: + name = user_id.lstrip("@").split(":")[0].capitalize() + user = User(user_id, name) + self._known_users[user_id] = user + return user._asdict() + + + @pyqtSlot(str, result=float) + def hueFromString(self, string: str) -> float: + # pylint: disable=no-self-use + md5 = hashlib.md5(bytes(string, "utf-8")).hexdigest() + return float("0.%s" % int(md5[-10:], 16)) diff --git a/harmonyqml/backend/dummy.py b/harmonyqml/backend/dummy.py new file mode 100644 index 00000000..669f34ad --- /dev/null +++ b/harmonyqml/backend/dummy.py @@ -0,0 +1,57 @@ +# Copyright 2019 miruka +# This file is part of harmonyqml, licensed under GPLv3. + +from PyQt5.QtCore import QDateTime, Qt + +from .base import Backend, Message, Room + + +class DummyBackend(Backend): + def __init__(self) -> None: + super().__init__() + + dt = lambda t: QDateTime.fromString(f"2019-03-19T{t}.123", + Qt.ISODateWithMs) + db = lambda t: QDateTime.fromString(f"2019-03-20T{t}.456", + Qt.ISODateWithMs) + + self.rooms.extend([ + Room("@renko:matrix.org", "!test:matrix.org", "Test", "Test room"), + Room("@renko:matrix.org", "!mary:matrix.org", "Mary", + "Lorem ipsum sit dolor amet", 2), + Room("@renko:matrix.org", "!foo:matrix.org", "Another room"), + + Room("@mary:matrix.org", "!test:matrix.org", "Test", "Test room"), + Room("@mary:matrix.org", "!mary:matrix.org", "Renko", + "Lorem ipsum sit dolor amet"), + ]) + + self.messages["!test:matrix.org"].extend([ + Message("@renko:matrix.org", dt("10:20:13"), "Lorem"), + Message("@renko:matrix.org", dt("10:22:01"), "Ipsum"), + Message("@renko:matrix.org", dt("10:22:50"), "Combine"), + Message("@renko:matrix.org", dt("10:30:41"), + "Time passed, don't combine"), + Message("@mary:matrix.org", dt("10:31:12"), + "Different person, don't combine"), + Message("@mary:matrix.org", dt("10:32:04"), + "But combine me"), + Message("@mary:matrix.org", dt("13:10:20"), + "Long time passed, conv break"), + + Message("@renko:matrix.org", db("10:22:01"), "Daybreak"), + Message("@mary:matrix.org", db("10:22:03"), + "A longer message to test text wrapping. " + "Lorem ipsum dolor sit amet, consectetuer adipiscing " + "elit. Aenean commodo ligula " + "eget dolor. Aenean massa. Cem sociis natoque penaibs " + "et magnis dis parturient montes, nascetur ridiculus " + "mus. Donec quam. "), + ]) + + self.messages["!mary:matrix.org"].extend([ + Message("@mary:matrix.org", dt("10:22:23"), "First"), + Message("@mary:matrix.org", dt("12:24:10"), "Second"), + ]) + + self.messages["!foo:matrix.org"].extend([]) diff --git a/harmonyqml/backend/enums.py b/harmonyqml/backend/enums.py new file mode 100644 index 00000000..8fb1c6e9 --- /dev/null +++ b/harmonyqml/backend/enums.py @@ -0,0 +1,31 @@ +# Copyright 2019 miruka +# This file is part of harmonyqml, licensed under GPLv3. + +from enum import Enum + + +class Activity(Enum): + none = 0 + focus = 1 + paused_typing = 2 + typing = 3 + + +class Presence(Enum): + none = 0 + offline = 1 + invisible = 2 + away = 3 + busy = 4 + online = 5 + + +class MessageKind(Enum): + audio = "m.audio" + emote = "m.emote" + file = "m.file" + image = "m.image" + location = "m.location" + notice = "m.notice" + text = "m.text" + video = "m.video" diff --git a/harmonyqml/backend/list_model.py b/harmonyqml/backend/list_model.py new file mode 100644 index 00000000..a9417fa2 --- /dev/null +++ b/harmonyqml/backend/list_model.py @@ -0,0 +1,191 @@ +import logging +from collections.abc import MutableSequence +from typing import Any, Dict, List, Mapping, Optional, Sequence, Tuple, Union + +from namedlist import namedlist +from PyQt5.QtCore import ( + QAbstractListModel, QModelIndex, Qt, pyqtProperty, pyqtSlot +) + +NewValue = Union[Mapping[str, Any], Sequence] + + +class _QtListModel(QAbstractListModel): + def __init__(self) -> None: + super().__init__() + self._ref_namedlist = None + self._roles: Tuple[str, ...] = () + self._list: list = [] + + def roleNames(self) -> Dict[int, bytes]: + return {Qt.UserRole + i: bytes(f, "utf-8") + for i, f in enumerate(self._roles, 1)} + + + def data(self, index: QModelIndex, role: int = Qt.DisplayRole) -> Any: + if role <= Qt.UserRole: + return None + + return self._list[index.row()][role - Qt.UserRole - 1] + + + def rowCount(self, _: QModelIndex = QModelIndex()) -> int: + return len(self._list) + + + def _convert_new_value(self, value: NewValue) -> Any: + if isinstance(value, Mapping): + if not self._ref_namedlist: + self._ref_namedlist = namedlist("ListItem", value.keys()) + self._roles = tuple(value.keys()) + + return self._ref_namedlist(**value) # type: ignore + + if isinstance(value, Sequence): + if not self._ref_namedlist: + try: + self._ref_namedlist = namedlist( + value.__class__.__name__, value._fields # type: ignore + ) + self._roles = tuple(value._fields) # type: ignore + except AttributeError: + raise TypeError( + "Need a mapping/dict, namedtuple or namedlist as " + "first value to set allowed keys/fields." + ) + + return self._ref_namedlist(*value) # type: ignore + + + raise TypeError("Value must be a mapping or sequence.") + + + @pyqtSlot(int, result="QVariantMap") + def get(self, index: int) -> Dict[str, Any]: + return self._list[index]._asdict() + + + @pyqtSlot(int, list) + def insert(self, index: int, value: NewValue) -> None: + value = self._convert_new_value(value) + self.beginInsertRows(QModelIndex(), index, index) + self._list.insert(index, value) + self.endInsertRows() + + + @pyqtProperty(int) + def count(self) -> int: + return self.rowCount() + + + @pyqtSlot(list) + def append(self, value: NewValue) -> None: + self.insert(self.rowCount(), value) + + + @pyqtSlot(int, list) + def set(self, index: int, value: NewValue) -> None: + qidx = self.index(index, 0) + value = self._convert_new_value(value) + self._list[index] = value + self.dataChanged.emit(qidx, qidx, self.roleNames()) + + + @pyqtSlot(int, str, "QVariant") + def setProperty(self, index: int, prop: str, value: Any) -> None: + self._list[index][self._roles.index(prop)] = value + qidx = self.index(index, 0) + self.dataChanged.emit(qidx, qidx, self.roleNames()) + + + # pylint: disable=invalid-name + @pyqtSlot(int, int) + @pyqtSlot(int, int, int) + def move(self, from_: int, to: int, n: int = 1) -> None: + qlast = from_ + n - 1 + + if (n <= 0) or (from_ == to) or (qlast == to) or \ + not (self.rowCount() > qlast >= 0) or \ + not self.rowCount() >= to >= 0: + logging.warning("No need for move or out of range") + return + + qidx = QModelIndex() + qto = min(self.rowCount(), to + n if to > from_ else to) + # print(f"self.beginMoveRows(qidx, {from_}, {qlast}, qidx, {qto})") + valid = self.beginMoveRows(qidx, from_, qlast, qidx, qto) + + if not valid: + logging.warning("Invalid move operation") + return + + last = from_ + n + cut = self._list[from_:last] + del self._list[from_:last] + self._list[to:to] = cut + + self.endMoveRows() + + + @pyqtSlot(int) + def remove(self, index: int) -> None: + self.beginRemoveRows(QModelIndex(), index, index) + del self._list[index] + self.endRemoveRows() + + + @pyqtSlot() + def clear(self) -> None: + # Reimplemented for performance reasons (begin/endRemoveRows) + self.beginRemoveRows(QModelIndex(), 0, self.rowCount()) + self._list.clear() + self.endRemoveRows() + + +class ListModel(MutableSequence): + def __init__(self, initial_data: Optional[List[NewValue]] = None) -> None: + super().__init__() + self.qt_model = _QtListModel() + + if initial_data: + self.extend(initial_data) + + + def __repr__(self) -> str: + return "%s[%s]" % (type(self).__name__, + ", ".join((repr(i) for i in self))) + + def __getitem__(self, index): + # pylint: disable=protected-access + return self.qt_model._list[index] + + + def __setitem__(self, index, value) -> None: + self.qt_model.set(index, value) + + + def __delitem__(self, index) -> None: + self.qt_model.remove(index) + + + def __len__(self) -> int: + return self.qt_model.rowCount() + + + def insert(self, index: int, value: NewValue) -> None: + self.qt_model.insert(index, value) + + + def setProperty(self, index: int, prop: str, value: Any) -> None: + "Set role of the item at *index* to *value*." + self.qt_model.setProperty(index, prop, value) + + + # pylint: disable=invalid-name + def move(self, from_: int, to: int, n: int = 1) -> None: + "Move *n* items *from_* index *to* another." + self.qt_model.move(from_, to, n) + + + def clear(self) -> None: + self.qt_model.clear() diff --git a/harmonyqml/main.jsc b/harmonyqml/main.jsc new file mode 100644 index 00000000..a949c56c Binary files /dev/null and b/harmonyqml/main.jsc differ diff --git a/setup.py b/setup.py new file mode 100755 index 00000000..2762addc --- /dev/null +++ b/setup.py @@ -0,0 +1,75 @@ +# Copyright 2019 miruka +# This file is part of harmonyqml, licensed under GPLv3. + +"harmonyqml setuptools file" + +from setuptools import setup, find_packages + +from harmonyqml import __about__ + + +def get_readme(): + with open("README.md", "r") as readme: + return readme.read() + + +setup( + name = __about__.__pkg_name__, + version = __about__.__version__, + + author = __about__.__author__, + author_email = __about__.__email__, + license = __about__.__license__, + + description = __about__.__doc__, + long_description = get_readme(), + long_description_content_type = "text/markdown", + + python_requires = ">=3.6, <4", + install_requires = [ + "dataclasses;python_version<'3.7'", + "docopt", + ], + + include_package_data = True, + packages = find_packages(), + # package_data = {__about__.__pkg_name__: ["*.yaml"]}, + entry_points = { + "console_scripts": [ + f"{__about__.__pkg_name__}={__about__.__pkg_name__}.cli:main" + ] + }, + + keywords = "", + url = "https://github.com/mirukan/harmonyqml", + + classifiers=[ + "Development Status :: 3 - Alpha", + # "Development Status :: 4 - Beta", + # "Development Status :: 5 - Production/Stable", + + "Intended Audience :: Developers", + "Intended Audience :: End Users/Desktop", + + "Environment :: Console", + # "Environment :: Console :: Curses", + # "Environment :: Plugins", + # "Environment :: X11 Applications", + # "Environment :: X11 Applications :: Qt", + + # "Topic :: Utilities", + # grep '^Topic' ~/docs/web/pypi-classifiers.txt + + ("License :: OSI Approved :: " + "GNU General Public License v3 or later (GPLv3+)"), + + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + + "Natural Language :: English", + + "Operating System :: POSIX", + ] +)