diff --git a/.arcconfig.license b/.arcconfig.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/.arcconfig.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/.gitmodules.license b/.gitmodules.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/.gitmodules.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/CMakeLists.txt b/CMakeLists.txt index 8b662dd..20cea3e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,28 +1,32 @@ +# SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + project(kairo) cmake_minimum_required(VERSION 3.2) if (POLICY CMP0063) cmake_policy(SET CMP0063 NEW) endif() find_package(ECM REQUIRED CONFIG) set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/ ${CMAKE_MODULE_PATH} ${ECM_MODULE_PATH}) find_package(Qt5 REQUIRED Core Quick Multimedia Test) include(KDEInstallDirs) include(KDECompilerSettings) include(KDECMakeSettings) include(FeatureSummary) set(CMAKE_CXX_STANDARD 11) set(CMAKE_CXX_EXTENSIONS OFF) find_package(KF5Kirigami2 ${REQUIRED_KF5_VERSION} CONFIG QUIET) set_package_properties(KF5Kirigami2 PROPERTIES DESCRIPTION "KF5 Kirigami 2 is needed to provide the mobile UI components." TYPE REQUIRED) add_subdirectory(src) add_subdirectory(tests) diff --git a/LICENSES/GPL-2.0-only.txt b/LICENSES/GPL-2.0-only.txt new file mode 100644 index 0000000..0f3d641 --- /dev/null +++ b/LICENSES/GPL-2.0-only.txt @@ -0,0 +1,319 @@ +GNU GENERAL PUBLIC LICENSE + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. + +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software +is covered by the GNU Lesser General Public License instead.) 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 this service 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 make restrictions that forbid anyone to +deny you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of +the software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or +for a fee, you must give the recipients all the rights that you have. 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. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If +the software is modified by someone else and passed on, we want its recipients +to know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will individually +obtain patent licenses, in effect making the program proprietary. To prevent +this, we have made it clear that any patent must be licensed for everyone's +free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms +of this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or translated +into another language. (Hereinafter, translation is included without limitation +in the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not covered +by this License; they are outside its scope. The act of running the Program +is not restricted, and the output from the Program is covered only if its +contents constitute a work based on the Program (independent of having been +made by running the Program). Whether that is true depends on what the Program +does. + +1. You may copy and distribute 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 and disclaimer of warranty; +keep intact all the notices that refer to this License and to the absence +of any warranty; and give any other recipients of the Program a copy of this +License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you +may at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, +thus forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all +of these conditions: + +a) You must cause the modified files to carry prominent notices stating that +you changed the files and the date of any change. + +b) You must cause any work that you distribute or publish, that in whole or +in part contains or is derived from the Program or any part thereof, to be +licensed as a whole at no charge to all third parties under the terms of this +License. + +c) If the modified program normally reads commands interactively when run, +you must cause it, when started running for such interactive use in the most +ordinary way, to print or display an announcement including an appropriate +copyright notice and a notice that there is no warranty (or else, saying that +you provide a warranty) and that users may redistribute the program under +these conditions, and telling the user how to view a copy of this License. +(Exception: if the Program itself is interactive but does not normally print +such an announcement, your work based on the Program is not required to print +an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, +and its terms, do not apply to those sections when you distribute them as +separate works. But when you distribute the same sections as part of a whole +which is a work based on the Program, the distribution of the whole must be +on the terms of this License, whose permissions for other licensees extend +to the entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise +the right to control the distribution of derivative or collective works based +on the Program. + +In addition, mere aggregation of another work not based on the Program with +the Program (or with a work based on the Program) on a volume of a storage +or distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under Section +2) in object code or executable form under the terms of Sections 1 and 2 above +provided that you also do one of the following: + +a) Accompany it with the complete corresponding machine-readable source code, +which must be distributed under the terms of Sections 1 and 2 above on a medium +customarily used for software interchange; or, + +b) Accompany it with a written offer, valid for at least three years, to give +any third party, for a charge no more than your cost of physically performing +source distribution, a complete machine-readable copy of the corresponding +source code, to be distributed under the terms of Sections 1 and 2 above on +a medium customarily used for software interchange; or, + +c) Accompany it with the information you received as to the offer to distribute +corresponding source code. (This alternative is allowed only for noncommercial +distribution and only if you received the program in object code or executable +form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code distributed +need not include anything that is normally distributed (in either source or +binary form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component itself +accompanies the executable. + +If distribution of executable or object code is made by offering access to +copy from a designated place, then offering equivalent access to copy the +source code from the same place counts as distribution of the source code, +even though third parties are not compelled to copy the source along with +the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except +as expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses terminated +so long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed +it. However, nothing else grants you permission to modify or distribute the +Program or its derivative works. These actions are prohibited by law if you +do not accept this License. Therefore, by modifying or distributing the Program +(or any work based on the Program), you indicate your acceptance of this License +to do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor +to copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of +the rights granted herein. You are not responsible for enforcing compliance +by third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement +or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your +obligations under this License and any other pertinent obligations, then as +a consequence you may not distribute the Program at all. For example, if a +patent license would not permit royalty-free redistribution of the Program +by all those who receive copies directly or indirectly through you, then the +only way you could satisfy both it and this License would be to refrain entirely +from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents +or other property right claims or to contest validity of any such claims; +this section has the sole purpose of protecting the integrity of the free +software distribution system, which is implemented by public license practices. +Many people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose +that choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original copyright +holder who places the Program under this License may add an explicit geographical +distribution limitation excluding those countries, so that distribution is +permitted only in or among countries not thus excluded. In such case, this +License incorporates the limitation as if written in the body of this License. + +9. The Free Software Foundation may publish revised and/or new versions of +the 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 +a version number of this License which applies to it and "any later version", +you have the option of following the terms and conditions either of that version +or of any later version published by the Free Software Foundation. If the +Program does not specify a version number of this License, you may choose +any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing and reuse +of software generally. + + NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE +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. +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 convey 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)< yyyy> + +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 2 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, write to the Free Software Foundation, Inc., 51 Franklin +Street, Fifth Floor, Boston, MA 02110-1301, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when +it starts in an interactive mode: + +Gnomovision version 69, Copyright (C) year name of author Gnomovision 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, the commands you use may be +called something other than `show w' and `show c'; they could even be mouse-clicks +or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + +Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' +(which makes passes at compilers) written by James Hacker. + +, 1 April 1989 Ty Coon, President of Vice This 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. diff --git a/LICENSES/GPL-3.0-only.txt b/LICENSES/GPL-3.0-only.txt new file mode 100644 index 0000000..e142a52 --- /dev/null +++ b/LICENSES/GPL-3.0-only.txt @@ -0,0 +1,625 @@ +GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright © 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/LICENSES/LicenseRef-KDE-Accepted-GPL.txt b/LICENSES/LicenseRef-KDE-Accepted-GPL.txt new file mode 100644 index 0000000..a2432d5 --- /dev/null +++ b/LICENSES/LicenseRef-KDE-Accepted-GPL.txt @@ -0,0 +1,13 @@ +This library 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) at any later version that is +accepted by the membership of KDE e.V. (or its successor +approved by the membership of KDE e.V.), which shall act as a +proxy as defined in Section 14 of version 3 of the license. + +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. + diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 8671d0a..57a91f8 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -1,31 +1,35 @@ +# SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + set(lib_SRCS circuitcontrol.cpp circuitlistmodel.cpp circuitmodel.cpp circuitreader.cpp timercontrol.cpp timermodel.cpp timernotificationcontrol.cpp soundcontrolinterface.cpp soundcontrol.cpp soundcontrolstub.cpp ) add_library(kairolib STATIC ${lib_SRCS}) target_link_libraries(kairolib Qt5::Quick Qt5::Multimedia ) set(exec_SRCS main.cpp ) qt5_add_resources(exec_SRCS main.qrc ) include_directories(${CMAKE_SOURCE_DIR}/3rdparty/kirigami/src) add_executable(kairo ${exec_SRCS}) target_link_libraries(kairo kairolib) install(TARGETS kairo DESTINATION ${KDE_INSTALL_BINDIR}) diff --git a/src/CircuitControlPage.qml b/src/CircuitControlPage.qml index 67a43b9..8b1f94b 100644 --- a/src/CircuitControlPage.qml +++ b/src/CircuitControlPage.qml @@ -1,97 +1,82 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. */ import QtQuick 2.0 import QtQuick.Layouts 1.2 import org.kde.kirigami 2.0 as Kirigami import Kairo 1.0 Kirigami.Page { id: root title: model.name topPadding: 0 leftPadding: 0 rightPadding: 0 bottomPadding: 0 property SoundControl soundControl property alias model: circuitControl.model signal circuitFinished() function start() { timer.running = true } actions.main: Kirigami.Action { iconName: "go-next" onTriggered: circuitControl.nextTimer() } TimerNotificationControl { sound: root.soundControl timer: TimerControl { id: timer running: false } } CircuitControl { id: circuitControl timerControl: timer onCircuitFinished: { timer.running = false root.circuitFinished() } } Rectangle { height: parent.height width: timer.duration <= 0 ? 0 : parent.width * (timer.duration - timer.value) / timer.duration color: timer.value > 10000 ? "lightSteelBlue" : "crimson" } ColumnLayout { anchors { left: parent.left right: parent.right verticalCenter: parent.verticalCenter } spacing: Kirigami.Units.gridUnit Kirigami.Heading { Layout.fillWidth: true horizontalAlignment: Text.AlignHCenter font.pixelSize: Kirigami.Theme.defaultFont.pixelSize * 4 text: timer.text wrapMode: Text.WordWrap } Kirigami.Label { Layout.fillWidth: true horizontalAlignment: Text.AlignHCenter font.pixelSize: Kirigami.Theme.defaultFont.pixelSize * 6 text: timer.formattedValue } } } diff --git a/src/CircuitListPage.qml b/src/CircuitListPage.qml index d00dca3..9bf6ec2 100644 --- a/src/CircuitListPage.qml +++ b/src/CircuitListPage.qml @@ -1,61 +1,46 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ import QtQuick 2.0 import org.kde.kirigami 2.0 as Kirigami import Kairo 1.0 Kirigami.ScrollablePage { id: root title: "Available Circuits" background: Rectangle { color: Kirigami.Theme.viewBackgroundColor } signal circuitSelected(var circuit) CircuitListModel { id: listModel } Text { anchors.centerIn: parent width: parent.width - 32 visible: listView.count === 0 font.pixelSize: Kirigami.Theme.defaultFont.pixelSize * 2 wrapMode: Text.Wrap text: "Place some circuit files in " + listModel.path } ListView { id: listView anchors.fill: parent model: listModel delegate: Kirigami.BasicListItem { reserveSpaceForIcon: false label: model.display onClicked: root.circuitSelected(listModel.loadCircuit(model.index)) } } } diff --git a/src/Dependencies.qml b/src/Dependencies.qml index b73100e..c53e6a3 100644 --- a/src/Dependencies.qml +++ b/src/Dependencies.qml @@ -1,13 +1,21 @@ +/* This file is part of Kairo Timer + + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + +*/ + import QtGraphicalEffects 1.0 import QtQml 2.1 import QtQml.Models 2.2 import QtQuick 2.7 import QtQuick.Controls 1.0 import QtQuick.Controls 2.1 import QtQuick.Controls.Material 2.0 import QtQuick.Layouts 1.2 import QtQuick.Templates 2.0 import QtQuick.Window 2.2 Item { } diff --git a/src/android/AndroidManifest.xml.license b/src/android/AndroidManifest.xml.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/android/AndroidManifest.xml.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/android/build.gradle.license b/src/android/build.gradle.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/android/build.gradle.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/android/gradle/wrapper/gradle-wrapper.jar.license b/src/android/gradle/wrapper/gradle-wrapper.jar.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/android/gradle/wrapper/gradle-wrapper.jar.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/android/gradle/wrapper/gradle-wrapper.properties.license b/src/android/gradle/wrapper/gradle-wrapper.properties.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/android/gradle/wrapper/gradle-wrapper.properties.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/android/gradlew.license b/src/android/gradlew.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/android/gradlew.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/android/res/values/libs.xml.license b/src/android/res/values/libs.xml.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/android/res/values/libs.xml.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/circuitcontrol.cpp b/src/circuitcontrol.cpp index c90e159..357f92e 100644 --- a/src/circuitcontrol.cpp +++ b/src/circuitcontrol.cpp @@ -1,148 +1,133 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include "circuitcontrol.h" #include "timercontrol.h" CircuitControl::CircuitControl(QObject *parent) : QObject{parent}, m_currentIndex{0}, m_timerControl{nullptr} { } CircuitModel CircuitControl::model() const { return m_model; } void CircuitControl::setModel(const CircuitModel &model) { if (model == m_model) return; auto m = model; setModel(std::move(m)); } void CircuitControl::setModel(CircuitModel &&model) { if (model == m_model) return; const auto oldName = name(); const auto oldSize = size(); const auto oldRemaining = remaining(); m_model = std::move(model); emit modelChanged(m_model); if (oldName != name()) emit nameChanged(name()); if (oldSize != size()) emit sizeChanged(size()); if (oldRemaining != remaining()) emit remainingChanged(size()); m_currentIndex = 0; applyCurrentTimer(); emit currentTimerChanged(currentTimer()); } TimerControl *CircuitControl::timerControl() const { return m_timerControl; } void CircuitControl::setTimerControl(TimerControl *timerControl) { if (timerControl == m_timerControl) return; if (m_timerControl) { connect(m_timerControl, &TimerControl::timerFinished, this, &CircuitControl::nextTimer); } m_timerControl = timerControl; if (m_timerControl) { connect(m_timerControl, &TimerControl::timerFinished, this, &CircuitControl::nextTimer); } emit timerControlChanged(timerControl); applyCurrentTimer(); } QString CircuitControl::name() const { return m_model.name(); } int CircuitControl::size() const { return m_model.size(); } int CircuitControl::remaining() const { if (currentTimer().isValid()) return m_model.size() - m_currentIndex; else return 0; } TimerModel CircuitControl::currentTimer() const { if (m_currentIndex < m_model.size()) return m_model.at(m_currentIndex); else return {}; } void CircuitControl::nextTimer() { const auto oldRemaining = remaining(); m_currentIndex++; applyCurrentTimer(); emit currentTimerChanged(currentTimer()); if (oldRemaining != remaining()) { emit remainingChanged(remaining()); if (remaining() == 0) emit circuitFinished(); } } void CircuitControl::applyCurrentTimer() { if (m_timerControl && m_timerControl->model() != currentTimer()) m_timerControl->setModel(currentTimer()); } diff --git a/src/circuitcontrol.h b/src/circuitcontrol.h index 6539d9b..fe12080 100644 --- a/src/circuitcontrol.h +++ b/src/circuitcontrol.h @@ -1,78 +1,63 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #ifndef CIRCUITCONTROL_H #define CIRCUITCONTROL_H #include #include "circuitmodel.h" class TimerControl; class CircuitControl : public QObject { Q_OBJECT Q_PROPERTY(CircuitModel model READ model WRITE setModel NOTIFY modelChanged) Q_PROPERTY(TimerControl* timerControl READ timerControl WRITE setTimerControl NOTIFY timerControlChanged) Q_PROPERTY(QString name READ name NOTIFY nameChanged) Q_PROPERTY(int size READ size NOTIFY sizeChanged) Q_PROPERTY(int remaining READ remaining NOTIFY remainingChanged) Q_PROPERTY(TimerModel currentTimer READ currentTimer NOTIFY currentTimerChanged) public: explicit CircuitControl(QObject *parent = nullptr); CircuitModel model() const; void setModel(const CircuitModel &model); void setModel(CircuitModel &&model); TimerControl *timerControl() const; void setTimerControl(TimerControl *timerControl); QString name() const; int size() const; int remaining() const; TimerModel currentTimer() const; public slots: void nextTimer(); signals: void modelChanged(const CircuitModel &model); void timerControlChanged(TimerControl *timerControl); void nameChanged(const QString &name); void sizeChanged(int size); void remainingChanged(int remaining); void currentTimerChanged(const TimerModel &model); void circuitFinished(); private: void applyCurrentTimer(); CircuitModel m_model; int m_currentIndex; TimerControl *m_timerControl; }; #endif diff --git a/src/circuitlistmodel.cpp b/src/circuitlistmodel.cpp index efd7d38..f520938 100644 --- a/src/circuitlistmodel.cpp +++ b/src/circuitlistmodel.cpp @@ -1,163 +1,148 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include "circuitlistmodel.h" #include #include #include #include #include "circuitreader.h" #ifdef Q_OS_ANDROID #include #endif CircuitListModel::CircuitListModel(QObject *parent) : QAbstractListModel{parent}, m_watcher{new QFileSystemWatcher{this}} { auto dir = storageDir(); if (!dir.exists()) dir.mkpath("."); connect(m_watcher, &QFileSystemWatcher::directoryChanged, this, &CircuitListModel::onDirectoryContentChanged); connect(m_watcher, &QFileSystemWatcher::fileChanged, this, &CircuitListModel::onDirectoryContentChanged); m_watcher->addPath(dir.path()); onDirectoryContentChanged(); } QHash CircuitListModel::roleNames() const { auto roles = QAbstractListModel::roleNames(); roles.insert(FilePathRole, "filePath"); return roles; } int CircuitListModel::rowCount(const QModelIndex &parent) const { if (!parent.isValid()) return m_circuits.size(); else return 0; } QVariant CircuitListModel::data(const QModelIndex &index, int role) const { if (index.parent().isValid() || index.row() < 0 || index.row() >= rowCount() || index.column() != 0) { return {}; } auto circuitFile = m_circuits.at(index.row()); switch (role) { case Qt::DisplayRole: return circuitFile.name; case FilePathRole: return circuitFile.filePath; default: return {}; } } CircuitModel CircuitListModel::loadCircuit(int index) { if (index < 0 || index >= m_circuits.size()) { qWarning() << "Wrong index passed to loadCircuit"; return {}; } const auto path = m_circuits.at(index).filePath; auto file = std::unique_ptr(new QFile(path)); auto reader = CircuitReader{file.get()}; return reader.readCircuit(); } QString CircuitListModel::path() const { #ifndef Q_OS_ANDROID return QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation); #else auto volumes = QStorageInfo::mountedVolumes(); auto paths = QStringList(); paths.reserve(volumes.size()); std::transform(volumes.constBegin(), volumes.constEnd(), std::back_inserter(paths), [] (const QStorageInfo &volume) { return volume.rootPath(); }); auto validPaths = QStringList(); std::copy_if(paths.constBegin(), paths.constEnd(), std::back_inserter(validPaths), [] (const QString &path) { return path.startsWith("/storage/") && !path.startsWith("/storage/emulated"); }); return validPaths.first() + "/Android/Kairo"; #endif } void CircuitListModel::onDirectoryContentChanged() { const auto entries = storageDir().entryInfoList({"*.kairo"}, QDir::Files|QDir::Readable); auto circuits = QVector{}; std::transform(entries.constBegin(), entries.constEnd(), std::back_inserter(circuits), [] (const QFileInfo &entry) { const auto path = entry.absoluteFilePath(); auto file = std::unique_ptr(new QFile(path)); auto reader = CircuitReader{file.get()}; const auto metaData = reader.readMetaData(); return CircuitFile{path, metaData.value("name").toString()}; }); std::sort(circuits.begin(), circuits.end()); if (m_circuits != circuits) { beginResetModel(); m_circuits = circuits; endResetModel(); } } QDir CircuitListModel::storageDir() { return {path()}; } bool CircuitListModel::CircuitFile::operator<(const CircuitListModel::CircuitFile &other) const { return name < other.name; } bool CircuitListModel::CircuitFile::operator==(const CircuitListModel::CircuitFile &other) const { return name == other.name && filePath == other.filePath; } diff --git a/src/circuitlistmodel.h b/src/circuitlistmodel.h index 6ab217c..203d419 100644 --- a/src/circuitlistmodel.h +++ b/src/circuitlistmodel.h @@ -1,73 +1,58 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #ifndef CIRCUITLISTMODEL_H #define CIRCUITLISTMODEL_H #include #include #include "circuitmodel.h" class QFileSystemWatcher; class CircuitListModel : public QAbstractListModel { Q_OBJECT Q_PROPERTY(QString path READ path CONSTANT) public: enum Role { FilePathRole = Qt::UserRole + 1 }; Q_ENUM(Role) explicit CircuitListModel(QObject *parent = nullptr); QHash roleNames() const override; Q_INVOKABLE int rowCount(const QModelIndex &parent = QModelIndex()) const override; QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override; Q_INVOKABLE CircuitModel loadCircuit(int index); QString path() const; private slots: void onDirectoryContentChanged(); private: QDir storageDir(); struct CircuitFile { QString filePath; QString name; bool operator<(const CircuitFile &other) const; bool operator==(const CircuitFile &other) const; }; QFileSystemWatcher *m_watcher; QVector m_circuits; }; #endif diff --git a/src/circuitmodel.cpp b/src/circuitmodel.cpp index c3880ed..5d59e8b 100644 --- a/src/circuitmodel.cpp +++ b/src/circuitmodel.cpp @@ -1,68 +1,53 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. */ #include "circuitmodel.h" CircuitModel::CircuitModel() = default; CircuitModel::CircuitModel(const QString &name, std::initializer_list content) : CircuitModel(name, QVector(content)) { } CircuitModel::CircuitModel(const QString &name, const QVector &content) : m_name(name), m_content(content) { } bool CircuitModel::operator==(const CircuitModel &other) const { return m_name == other.m_name && m_content == other.m_content; } bool CircuitModel::operator!=(const CircuitModel &other) const { return !(*this == other); } QString CircuitModel::name() const { return m_name; } bool CircuitModel::isEmpty() const { return m_content.isEmpty(); } int CircuitModel::size() const { return m_content.size(); } TimerModel CircuitModel::at(int index) const { return m_content.at(index); } diff --git a/src/circuitmodel.h b/src/circuitmodel.h index f83ca0e..3a3af7f 100644 --- a/src/circuitmodel.h +++ b/src/circuitmodel.h @@ -1,60 +1,45 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #ifndef CIRCUITMODEL_H #define CIRCUITMODEL_H #include #include #include "timermodel.h" class CircuitModel { Q_GADGET Q_PROPERTY(QString name READ name) Q_PROPERTY(bool empty READ isEmpty) Q_PROPERTY(int size READ size) public: CircuitModel(); CircuitModel(const QString &name, std::initializer_list content); CircuitModel(const QString &name, const QVector &content); bool operator==(const CircuitModel &other) const; bool operator!=(const CircuitModel &other) const; QString name() const; bool isEmpty() const; int size() const; Q_INVOKABLE TimerModel at(int index) const; private: QString m_name; QVector m_content; }; Q_DECLARE_METATYPE(CircuitModel) #endif diff --git a/src/circuitreader.cpp b/src/circuitreader.cpp index 4acc637..70bb083 100644 --- a/src/circuitreader.cpp +++ b/src/circuitreader.cpp @@ -1,198 +1,183 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include "circuitreader.h" #include #include #include #include #include #include #include CircuitReader::CircuitReader(QIODevice *device) : m_device{device} { } CircuitReader::CircuitReader(CircuitReader &&other) : m_device{other.m_device}, m_metaData{other.m_metaData} { other.m_device = nullptr; other.m_metaData.clear(); } CircuitReader &CircuitReader::operator=(CircuitReader &&other) { m_device = other.m_device; m_metaData = other.m_metaData; other.m_device = nullptr; other.m_metaData.clear(); return *this; } QIODevice *CircuitReader::device() const { return m_device; } CircuitReader::MetaData CircuitReader::readMetaData() { if (!m_device) return {}; if (!m_device->isOpen() && !m_device->open(QIODevice::ReadOnly)) return {}; if (m_device->pos() > 0) return m_metaData; auto line = QString::fromUtf8(m_device->readLine()).trimmed(); if (line != QStringLiteral("---")) return {}; auto metaData = MetaData{}; line = QString::fromUtf8(m_device->readLine()).trimmed(); while (!m_device->atEnd() && line != QStringLiteral("---")) { const auto columnIndex = line.indexOf(':'); if (columnIndex < 0) return {}; const auto key = line.left(columnIndex).simplified(); const auto value = line.mid(columnIndex + 1).simplified(); metaData.insert(key, value); line = QString::fromUtf8(m_device->readLine()).trimmed(); } if (line != QStringLiteral("---")) return {}; m_metaData = metaData; return m_metaData; } namespace { bool isLoopObject(const QJsonObject &object) { return object.contains("content") && object.contains("count"); } bool isTimerObject(const QJsonObject &object) { return object.contains("text") && !isLoopObject(object); } TimerModel convertTimerObject(const QJsonObject &object) { return { object.value("text").toString(), object.value("duration").toInt() }; } QVector convertLoopObject(const QJsonObject &object) { const auto count = object.value("count").toInt(); if (count <= 0) return {}; const auto content = object.value("content"); if (!content.isArray()) return {}; auto array = content.toArray(); if (array.isEmpty()) return {}; const auto end = std::remove_if(array.begin(), array.end(), [] (const QJsonValue &value) { return !value.isObject() || !isTimerObject(value.toObject()); }); const auto text = object.value("text").toString(); const auto prefix = text.isEmpty() ? QString{} : text + ", "; auto loop = QVector{}; for (int i = 0; i < count; i++) { auto timers = QVector{}; std::transform(array.begin(), end, std::back_inserter(timers), [prefix, i, count] (const QJsonValue &value) { const auto timer = convertTimerObject(value.toObject()); return TimerModel{ QString("%1%2 (%3/%4)").arg(prefix).arg(timer.text()).arg(i + 1).arg(count), timer.duration() }; }); loop += timers; } const auto removeLast = object.value("removeLast").toBool(); if (removeLast) loop.removeLast(); return loop; } } CircuitModel CircuitReader::readCircuit() { if (!m_device) return {}; if (!m_device->isOpen()) readMetaData(); auto content = QVector{}; const auto data = m_device->readAll(); const auto json = QJsonDocument::fromJson(data); if (json.isArray()) { const auto array = json.array(); const auto end = std::remove_if(array.begin(), array.end(), [] (const QJsonValue &value) { return !value.isObject(); }); auto objects = QVector{}; auto toObject = std::mem_fn(static_cast(&QJsonValue::toObject)); std::transform(array.begin(), end, std::back_inserter(objects), toObject); content = std::accumulate(objects.begin(), objects.end(), content, [] (const QVector &content, const QJsonObject &object) { auto timers = content; if (isTimerObject(object)) timers << convertTimerObject(object); else if (isLoopObject(object)) timers += convertLoopObject(object); return timers; }); } return {m_metaData.value("name").toString(), content}; } diff --git a/src/circuitreader.h b/src/circuitreader.h index e031186..b85d621 100644 --- a/src/circuitreader.h +++ b/src/circuitreader.h @@ -1,56 +1,41 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #ifndef CIRCUITREADER_H #define CIRCUITREADER_H #include #include #include "circuitmodel.h" class QIODevice; class CircuitReader { public: using MetaData = QHash; explicit CircuitReader(QIODevice *device = nullptr); CircuitReader(CircuitReader &&other); CircuitReader &operator=(CircuitReader &&other); QIODevice *device() const; MetaData readMetaData(); CircuitModel readCircuit(); private: CircuitReader(const CircuitReader &) = delete; CircuitReader &operator=(const CircuitReader &) = delete; QIODevice *m_device; MetaData m_metaData; }; #endif diff --git a/src/endbeep.wav.license b/src/endbeep.wav.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/endbeep.wav.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/kairo.pro b/src/kairo.pro index a098938..5171032 100644 --- a/src/kairo.pro +++ b/src/kairo.pro @@ -1,24 +1,28 @@ +# Copyright 2016 Kevin Ottens + +# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + TEMPLATE = app TARGET = kairo include(../3rdparty/kirigami/kirigami.pri) INCLUDEPATH += . QT += quick multimedia CONFIG += c++11 # Input HEADERS += *.h SOURCES += *.cpp RESOURCES += *.qrc DISTFILES += \ android/AndroidManifest.xml \ android/gradle/wrapper/gradle-wrapper.jar \ android/gradlew \ android/res/values/libs.xml \ android/build.gradle \ android/gradle/wrapper/gradle-wrapper.properties \ android/gradlew.bat ANDROID_PACKAGE_SOURCE_DIR = $$PWD/android diff --git a/src/kirigami-icons.qrc.license b/src/kirigami-icons.qrc.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/kirigami-icons.qrc.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/longbeep.wav.license b/src/longbeep.wav.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/longbeep.wav.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/main.cpp b/src/main.cpp index 767b6d2..a1cf7bf 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,53 +1,38 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include #include #include "circuitcontrol.h" #include "circuitlistmodel.h" #include "circuitmodel.h" #include "timercontrol.h" #include "timermodel.h" #include "timernotificationcontrol.h" #include "soundcontrol.h" int main(int argc, char **argv) { QGuiApplication app(argc, argv); app.setApplicationName("Kairo"); qmlRegisterType("Kairo", 1, 0, "CircuitListModel"); qmlRegisterUncreatableType("Kairo", 1, 0, "CircuitModel", "Loaded from C++"); qmlRegisterType("Kairo", 1, 0, "CircuitControl"); qmlRegisterUncreatableType("Kairo", 1, 0, "TimerModel", "Use TimerControl.createModel()"); qmlRegisterType("Kairo", 1, 0, "TimerControl"); qmlRegisterType("Kairo", 1, 0, "TimerNotificationControl"); qmlRegisterUncreatableType("Kairo", 1, 0, "SoundControlInterface", "Use SoundControl"); qmlRegisterType("Kairo", 1, 0, "SoundControl"); QQmlApplicationEngine engine; engine.load(QUrl(QStringLiteral("qrc:/main.qml"))); return app.exec(); } diff --git a/src/main.qml b/src/main.qml index 8eae6e2..9b35ac8 100644 --- a/src/main.qml +++ b/src/main.qml @@ -1,75 +1,60 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. */ import QtQuick 2.0 import Kairo 1.0 import org.kde.kirigami 2.0 as Kirigami Kirigami.ApplicationWindow { id: root visible: true width: 640 height: 480 header: Kirigami.ApplicationHeader {} pageStack.initialPage: listComponent pageStack.defaultColumnWidth: width Connections { target: pageStack.contentItem onContentXChanged: { if (pageStack.depth > 1 && pageStack.contentItem.contentX === 0) pageStack.pop() } } SoundControl { id: soundControl } Component { id: listComponent CircuitListPage { onCircuitSelected: { var page = controlComponent.createObject(root) page.model = circuit page.soundControl = soundControl root.pageStack.push(page) page.start() } } } Component { id: controlComponent CircuitControlPage { onCircuitFinished: { root.pageStack.currentIndex = 0 soundControl.playEndBeep() } } } } diff --git a/src/main.qrc.license b/src/main.qrc.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/main.qrc.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/shortbeep.wav.license b/src/shortbeep.wav.license new file mode 100644 index 0000000..571671c --- /dev/null +++ b/src/shortbeep.wav.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL diff --git a/src/soundcontrol.cpp b/src/soundcontrol.cpp index 1244943..37a3d05 100644 --- a/src/soundcontrol.cpp +++ b/src/soundcontrol.cpp @@ -1,50 +1,35 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include "soundcontrol.h" #include SoundControl::SoundControl(QObject *parent) : SoundControlInterface{parent}, m_player{new QMediaPlayer{this}} { } void SoundControl::playShortBeep() { m_player->setMedia(QUrl("qrc:/shortbeep.wav")); m_player->play(); } void SoundControl::playLongBeep() { m_player->setMedia(QUrl("qrc:/longbeep.wav")); m_player->play(); } void SoundControl::playEndBeep() { m_player->setMedia(QUrl("qrc:/endbeep.wav")); m_player->play(); } diff --git a/src/soundcontrol.h b/src/soundcontrol.h index ccb606e..e3fe998 100644 --- a/src/soundcontrol.h +++ b/src/soundcontrol.h @@ -1,46 +1,31 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #ifndef SOUNDCONTROL_H #define SOUNDCONTROL_H #include "soundcontrolinterface.h" class QMediaPlayer; class SoundControl : public SoundControlInterface { Q_OBJECT public: explicit SoundControl(QObject *parent = nullptr); public slots: void playShortBeep() override; void playLongBeep() override; void playEndBeep() override; private: QMediaPlayer *m_player; }; #endif diff --git a/src/soundcontrolinterface.cpp b/src/soundcontrolinterface.cpp index 8190315..c0a1a42 100644 --- a/src/soundcontrolinterface.cpp +++ b/src/soundcontrolinterface.cpp @@ -1,29 +1,14 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. */ #include "soundcontrolinterface.h" SoundControlInterface::SoundControlInterface(QObject *parent) : QObject{parent} { } diff --git a/src/soundcontrolinterface.h b/src/soundcontrolinterface.h index e5c0380..7988487 100644 --- a/src/soundcontrolinterface.h +++ b/src/soundcontrolinterface.h @@ -1,41 +1,26 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #ifndef SOUNDCONTROLINTERFACE_H #define SOUNDCONTROLINTERFACE_H #include class SoundControlInterface : public QObject { Q_OBJECT public: explicit SoundControlInterface(QObject *parent = nullptr); public slots: virtual void playShortBeep() = 0; virtual void playLongBeep() = 0; virtual void playEndBeep() = 0; }; #endif diff --git a/src/soundcontrolstub.cpp b/src/soundcontrolstub.cpp index aa989da..b94fad6 100644 --- a/src/soundcontrolstub.cpp +++ b/src/soundcontrolstub.cpp @@ -1,54 +1,39 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include "soundcontrolstub.h" SoundControlStub::SoundControlStub(QObject *parent) : SoundControlInterface{parent} { } QVector SoundControlStub::calls() const { return m_calls; } void SoundControlStub::clear() { m_calls.clear(); } void SoundControlStub::playShortBeep() { m_calls << ShortBeep; } void SoundControlStub::playLongBeep() { m_calls << LongBeep; } void SoundControlStub::playEndBeep() { m_calls << EndBeep; } diff --git a/src/soundcontrolstub.h b/src/soundcontrolstub.h index 5467088..ea82d77 100644 --- a/src/soundcontrolstub.h +++ b/src/soundcontrolstub.h @@ -1,55 +1,40 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #ifndef SOUNDCONTROLSTUB_H #define SOUNDCONTROLSTUB_H #include "soundcontrolinterface.h" #include class SoundControlStub : public SoundControlInterface { Q_OBJECT public: enum SoundType { ShortBeep, LongBeep, EndBeep }; explicit SoundControlStub(QObject *parent = nullptr); QVector calls() const; void clear(); public slots: void playShortBeep() override; void playLongBeep() override; void playEndBeep() override; private: QVector m_calls; }; #endif diff --git a/src/timercontrol.cpp b/src/timercontrol.cpp index 707f795..4318a16 100644 --- a/src/timercontrol.cpp +++ b/src/timercontrol.cpp @@ -1,159 +1,144 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include "timercontrol.h" #include #include #include TimerControl::TimerControl(QObject *parent) : QObject{parent}, m_timer{new QTimer{this}} { m_timer->setTimerType(Qt::PreciseTimer); m_timer->setInterval(10); connect(m_timer, &QTimer::timeout, this, &TimerControl::onTimerTimeout); } TimerModel TimerControl::createModel() const { return {}; } TimerModel TimerControl::createModel(const QString &text, int duration) const { return {text, duration}; } TimerModel TimerControl::model() const { return m_model; } void TimerControl::setModel(const TimerModel &model) { if (model == m_model) return; auto m = model; setModel(std::move(m)); } void TimerControl::setModel(TimerModel &&model) { if (model == m_model) return; const auto oldText = text(); const auto oldValue = value(); const auto oldDuration = duration(); const auto skipped = m_running && m_model.isValid() && oldValue != 0; m_model = std::move(model); m_value = m_model.type() == TimerModel::Countdown ? m_model.duration() : 0; if (m_running) m_timer->start(); emit modelChanged(m_model); if (skipped) emit timerSkipped(); if (oldText != text()) emit textChanged(text()); if (oldValue != value()) { emit valueChanged(value()); emit formattedValueChanged(formattedValue()); } if (oldDuration != duration()) emit durationChanged(duration()); } QString TimerControl::text() const { return m_model.text(); } int TimerControl::value() const { return m_value; } QString TimerControl::formattedValue() const { qreal time = qRound((qreal)m_value / (qreal)100)/(qreal)10; int minutes = qFloor(time / 60); //seconds rounded to first decimal position int seconds = qFloor(time - minutes * 60); return QStringLiteral("%1:%2.%3") .arg(minutes, 2, 10, QLatin1Char('0')) .arg(seconds, 2, 10, QLatin1Char('0')) .arg(((time - qFloor(time)) * 10)); } int TimerControl::duration() const { return m_model.duration(); } bool TimerControl::isRunning() const { return m_running; } void TimerControl::setRunning(bool running) { if (running == m_running) return; m_running = running; emit runningChanged(m_running); if (!m_model.isValid()) { if (m_running) emit timerFinished(); m_timer->stop(); } else if (!m_running) { m_timer->stop(); } else { m_timer->start(); } } void TimerControl::onTimerTimeout() { m_value += m_model.type() == TimerModel::Countdown ? -10 : 10; emit valueChanged(m_value); emit formattedValueChanged(formattedValue()); if (m_value == 0) { m_timer->stop(); emit timerFinished(); } } diff --git a/src/timercontrol.h b/src/timercontrol.h index 5000c9e..da22fe9 100644 --- a/src/timercontrol.h +++ b/src/timercontrol.h @@ -1,82 +1,67 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #ifndef TIMERCONTROL_H #define TIMERCONTROL_H #include #include "timermodel.h" class QTimer; class TimerControl : public QObject { Q_OBJECT Q_PROPERTY(TimerModel model READ model WRITE setModel NOTIFY modelChanged) Q_PROPERTY(QString text READ text NOTIFY textChanged) Q_PROPERTY(int value READ value NOTIFY valueChanged) Q_PROPERTY(QString formattedValue READ formattedValue NOTIFY formattedValueChanged) Q_PROPERTY(int duration READ duration NOTIFY durationChanged) Q_PROPERTY(bool running READ isRunning WRITE setRunning NOTIFY runningChanged) public: explicit TimerControl(QObject *parent = nullptr); Q_INVOKABLE TimerModel createModel() const; Q_INVOKABLE TimerModel createModel(const QString &text, int duration = 0) const; TimerModel model() const; void setModel(const TimerModel &model); void setModel(TimerModel &&model); QString text() const; int value() const; QString formattedValue() const; int duration() const; bool isRunning() const; public slots: void setRunning(bool running); signals: void modelChanged(const TimerModel &model); void textChanged(const QString &text); void valueChanged(int value); void durationChanged(int duration); void runningChanged(bool running); void formattedValueChanged(const QString &formattedValue); void timerFinished(); void timerSkipped(); private slots: void onTimerTimeout(); private: TimerModel m_model; QTimer *m_timer; bool m_running = false; int m_value = 0; }; #endif diff --git a/src/timermodel.cpp b/src/timermodel.cpp index 7da7ed2..2021052 100644 --- a/src/timermodel.cpp +++ b/src/timermodel.cpp @@ -1,65 +1,50 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. */ #include "timermodel.h" TimerModel::TimerModel() = default; TimerModel::TimerModel(const QString &text, int duration) : m_text{text}, m_duration{duration} { } bool TimerModel::operator==(const TimerModel &other) const { return (m_text == other.m_text) && (m_duration == other.m_duration); } bool TimerModel::operator!=(const TimerModel &other) const { return !(*this == other); } QString TimerModel::text() const { return m_text; } int TimerModel::duration() const { return m_duration; } TimerModel::Type TimerModel::type() const { return m_duration < 0 ? Invalid : m_duration == 0 ? Stopwatch : Countdown; } bool TimerModel::isValid() const { return type() != Invalid; } diff --git a/src/timermodel.h b/src/timermodel.h index 10b87af..e218fd7 100644 --- a/src/timermodel.h +++ b/src/timermodel.h @@ -1,64 +1,49 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. */ #ifndef TIMERMODEL_H #define TIMERMODEL_H #include #include class TimerModel { Q_GADGET Q_PROPERTY(QString text READ text) Q_PROPERTY(int duration READ duration) Q_PROPERTY(Type type READ type) Q_PROPERTY(bool valid READ isValid) public: enum Type { Invalid, Countdown, Stopwatch }; Q_ENUM(Type) TimerModel(); TimerModel(const QString &text, int duration = 0); bool operator==(const TimerModel &other) const; bool operator!=(const TimerModel &other) const; QString text() const; int duration() const; Type type() const; bool isValid() const; private: QString m_text = {}; int m_duration = -1; }; Q_DECLARE_METATYPE(TimerModel) #endif diff --git a/src/timernotificationcontrol.cpp b/src/timernotificationcontrol.cpp index 0a8c52b..081d3c2 100644 --- a/src/timernotificationcontrol.cpp +++ b/src/timernotificationcontrol.cpp @@ -1,108 +1,93 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include "timernotificationcontrol.h" #include #include "soundcontrolinterface.h" #include "timercontrol.h" TimerNotificationControl::TimerNotificationControl(QObject *parent) : QObject{parent}, m_sound{nullptr}, m_timer{nullptr} { } SoundControlInterface *TimerNotificationControl::sound() const { return m_sound; } TimerControl *TimerNotificationControl::timer() const { return m_timer; } void TimerNotificationControl::setSound(SoundControlInterface *sound) { if (sound == m_sound) return; m_sound = sound; emit soundChanged(sound); } void TimerNotificationControl::setTimer(TimerControl *timer) { if (timer == m_timer) return; if (m_timer) { disconnect(m_timer, &TimerControl::timerFinished, this, &TimerNotificationControl::onTimerFinished); disconnect(m_timer, &TimerControl::timerSkipped, this, &TimerNotificationControl::onTimerSkipped); disconnect(m_timer, &TimerControl::valueChanged, this, &TimerNotificationControl::onTimerValueChanged); } m_timer = timer; if (m_timer) { connect(m_timer, &TimerControl::timerFinished, this, &TimerNotificationControl::onTimerFinished); connect(m_timer, &TimerControl::timerSkipped, this, &TimerNotificationControl::onTimerSkipped); connect(m_timer, &TimerControl::valueChanged, this, &TimerNotificationControl::onTimerValueChanged); } emit timerChanged(timer); } void TimerNotificationControl::onTimerFinished() { if (!m_sound) return; m_sound->playLongBeep(); } void TimerNotificationControl::onTimerSkipped() { if (!m_sound) return; m_sound->playShortBeep(); } void TimerNotificationControl::onTimerValueChanged(int ms) { if (!m_sound) return; if (m_timer->model().type() != TimerModel::Countdown) return; auto seconds = ms / 1000.0; if (static_cast(seconds) == qCeil(seconds) && 1.0 <= seconds && seconds <= 10.0) { m_sound->playShortBeep(); } } diff --git a/src/timernotificationcontrol.h b/src/timernotificationcontrol.h index 26fbbc9..d1a8615 100644 --- a/src/timernotificationcontrol.h +++ b/src/timernotificationcontrol.h @@ -1,61 +1,46 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #ifndef TIMERNOTIFICATIONCONTROL_H #define TIMERNOTIFICATIONCONTROL_H #include class SoundControlInterface; class TimerControl; class TimerNotificationControl : public QObject { Q_OBJECT Q_PROPERTY(SoundControlInterface* sound READ sound WRITE setSound NOTIFY soundChanged) Q_PROPERTY(TimerControl* timer READ timer WRITE setTimer NOTIFY timerChanged) public: explicit TimerNotificationControl(QObject *parent = nullptr); SoundControlInterface *sound() const; TimerControl *timer() const; public slots: void setSound(SoundControlInterface *sound); void setTimer(TimerControl *timer); signals: void soundChanged(SoundControlInterface *timer); void timerChanged(TimerControl *timer); private slots: void onTimerFinished(); void onTimerSkipped(); void onTimerValueChanged(int ms); private: SoundControlInterface *m_sound; TimerControl *m_timer; }; #endif diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 7178106..d1a2390 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -1,25 +1,29 @@ +# SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + +# SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + set(CMAKE_CXX_STANDARD 14) include_directories(${CMAKE_SOURCE_DIR}/src) include_directories(${CMAKE_CURRENT_SOURCE_DIR}) macro(kairo_auto_tests) foreach(_testname ${ARGN}) add_executable(${_testname} ${_testname}.cpp) add_test(${_testname} ${_testname}) target_link_libraries(${_testname} Qt5::Test kairolib ) endforeach(_testname) endmacro(kairo_auto_tests) kairo_auto_tests( circuitcontroltest circuitlistmodeltest circuitmodeltest circuitreadertest timercontroltest timermodeltest timernotificationcontroltest ) diff --git a/tests/circuitcontroltest.cpp b/tests/circuitcontroltest.cpp index 9ce43c3..f7c9c9d 100644 --- a/tests/circuitcontroltest.cpp +++ b/tests/circuitcontroltest.cpp @@ -1,321 +1,306 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include #include #include #include "circuitcontrol.h" #include "timercontrol.h" class CircuitControlTest : public QObject { Q_OBJECT private slots: void initTestCase() { qRegisterMetaType(); } void shouldHaveDefaultState() { // GIVEN auto control = std::make_unique(); // THEN QCOMPARE(control->model(), CircuitModel{}); QCOMPARE(control->timerControl(), static_cast(nullptr)); QCOMPARE(control->name(), QString()); QCOMPARE(control->size(), 0); QCOMPARE(control->remaining(), 0); QCOMPARE(control->currentTimer(), TimerModel{}); } void shouldKnowTimerControl() { // GIVEN auto control = std::make_unique(); auto timerControlSpy = std::make_unique(control.get(), &CircuitControl::timerControlChanged); auto timerControl = new TimerControl(control.get()); // WHEN control->setTimerControl(timerControl); // THEN QCOMPARE(control->timerControl(), timerControl); QCOMPARE(timerControlSpy->size(), 1); QCOMPARE(timerControlSpy->takeFirst().first().value(), timerControl); // WHEN control->setTimerControl(timerControl); // THEN QCOMPARE(control->timerControl(), timerControl); QCOMPARE(timerControlSpy->size(), 0); } void shouldDeriveValuesFromModel_data() { QTest::addColumn("model"); QTest::newRow("empty and unnamed") << CircuitModel{}; QTest::newRow("empty and named") << CircuitModel{"foo", {}}; QTest::newRow("with data") << CircuitModel{"foo", {{"rest", 10000}, {"run"}, {"rest", 5000}}}; } void shouldDeriveValuesFromModel() { // GIVEN auto control = std::make_unique(); auto modelSpy = std::make_unique(control.get(), &CircuitControl::modelChanged); auto nameSpy = std::make_unique(control.get(), &CircuitControl::nameChanged); auto sizeSpy = std::make_unique(control.get(), &CircuitControl::sizeChanged); auto remainingSpy = std::make_unique(control.get(), &CircuitControl::remainingChanged); auto currentTimerSpy = std::make_unique(control.get(), &CircuitControl::currentTimerChanged); QFETCH(CircuitModel, model); // WHEN control->setModel(model); // THEN QCOMPARE(control->model(), model); QCOMPARE(control->name(), model.name()); QCOMPARE(control->size(), model.size()); QCOMPARE(control->remaining(), model.size()); if (!model.name().isEmpty() || !model.isEmpty()) { QCOMPARE(modelSpy->size(), 1); QCOMPARE(modelSpy->takeFirst().first().value(), model); } else { QCOMPARE(modelSpy->size(), 0); } if (!model.name().isEmpty()) { QCOMPARE(nameSpy->size(), 1); QCOMPARE(nameSpy->takeFirst().first().toString(), model.name()); } else { QCOMPARE(nameSpy->size(), 0); } if (!model.isEmpty()) { QCOMPARE(sizeSpy->size(), 1); QCOMPARE(sizeSpy->takeFirst().first().toInt(), model.size()); QCOMPARE(remainingSpy->size(), 1); QCOMPARE(remainingSpy->takeFirst().first().toInt(), model.size()); if (!model.name().isEmpty()) { QCOMPARE(currentTimerSpy->size(), 1); QCOMPARE(currentTimerSpy->takeFirst().first().value(), model.at(0)); } else { QCOMPARE(currentTimerSpy->size(), 0); } } else { QCOMPARE(sizeSpy->size(), 0); QCOMPARE(remainingSpy->size(), 0); if (!model.name().isEmpty()) { QCOMPARE(currentTimerSpy->size(), 1); QCOMPARE(currentTimerSpy->takeFirst().first().value(), TimerModel{}); } else { QCOMPARE(currentTimerSpy->size(), 0); } } // WHEN control->setModel(model); // THEN QCOMPARE(modelSpy->size(), 0); QCOMPARE(nameSpy->size(), 0); QCOMPARE(sizeSpy->size(), 0); QCOMPARE(remainingSpy->size(), 0); QCOMPARE(currentTimerSpy->size(), 0); } void shouldDeriveValuesFromMovedModel_data() { shouldDeriveValuesFromModel_data(); } void shouldDeriveValuesFromMovedModel() { // GIVEN auto control = std::make_unique(); auto modelSpy = std::make_unique(control.get(), &CircuitControl::modelChanged); auto nameSpy = std::make_unique(control.get(), &CircuitControl::nameChanged); auto sizeSpy = std::make_unique(control.get(), &CircuitControl::sizeChanged); auto remainingSpy = std::make_unique(control.get(), &CircuitControl::remainingChanged); auto currentTimerSpy = std::make_unique(control.get(), &CircuitControl::currentTimerChanged); QFETCH(CircuitModel, model); // WHEN auto copy = model; control->setModel(std::move(copy)); // This should move it in place // THEN QCOMPARE(control->model(), model); QCOMPARE(control->name(), model.name()); QCOMPARE(control->size(), model.size()); QCOMPARE(control->remaining(), model.size()); if (!model.name().isEmpty() || !model.isEmpty()) { QCOMPARE(modelSpy->size(), 1); QCOMPARE(modelSpy->takeFirst().first().value(), model); } else { QCOMPARE(modelSpy->size(), 0); } if (!model.name().isEmpty()) { QCOMPARE(nameSpy->size(), 1); QCOMPARE(nameSpy->takeFirst().first().toString(), model.name()); } else { QCOMPARE(nameSpy->size(), 0); } if (!model.isEmpty()) { QCOMPARE(sizeSpy->size(), 1); QCOMPARE(sizeSpy->takeFirst().first().toInt(), model.size()); QCOMPARE(remainingSpy->size(), 1); QCOMPARE(remainingSpy->takeFirst().first().toInt(), model.size()); if (!model.name().isEmpty()) { QCOMPARE(currentTimerSpy->size(), 1); QCOMPARE(currentTimerSpy->takeFirst().first().value(), model.at(0)); } else { QCOMPARE(currentTimerSpy->size(), 0); } } else { QCOMPARE(sizeSpy->size(), 0); QCOMPARE(remainingSpy->size(), 0); if (!model.name().isEmpty()) { QCOMPARE(currentTimerSpy->size(), 1); QCOMPARE(currentTimerSpy->takeFirst().first().value(), TimerModel{}); } else { QCOMPARE(currentTimerSpy->size(), 0); } } // WHEN control->setModel(std::move(model)); // THEN QCOMPARE(modelSpy->size(), 0); QCOMPARE(nameSpy->size(), 0); QCOMPARE(sizeSpy->size(), 0); QCOMPARE(remainingSpy->size(), 0); QCOMPARE(currentTimerSpy->size(), 0); } void shouldPushNextTimerOnFinishOrSkip() { // GIVEN auto control = std::make_unique(); auto timerControl = new TimerControl(control.get()); control->setModel({ "foo", { {"mooh"}, {"rest", 10000}, {"run"}, {"rest", 5000} } }); auto remainingSpy = std::make_unique(control.get(), &CircuitControl::remainingChanged); auto currentTimerSpy = std::make_unique(control.get(), &CircuitControl::currentTimerChanged); auto finishedSpy = std::make_unique(control.get(), &CircuitControl::circuitFinished); // WHEN control->nextTimer(); // THEN QCOMPARE(control->currentTimer(), control->model().at(1)); QCOMPARE(control->remaining(), 3); QCOMPARE(remainingSpy->size(), 1); QCOMPARE(remainingSpy->takeFirst().first().toInt(), 3); QCOMPARE(currentTimerSpy->size(), 1); QCOMPARE(currentTimerSpy->takeFirst().first().value(), control->model().at(1)); QCOMPARE(finishedSpy->size(), 0); // WHEN control->setTimerControl(timerControl); // THEN QCOMPARE(timerControl->model(), control->currentTimer()); QCOMPARE(timerControl->model(), control->model().at(1)); QCOMPARE(control->remaining(), 3); QCOMPARE(remainingSpy->size(), 0); QCOMPARE(currentTimerSpy->size(), 0); QCOMPARE(finishedSpy->size(), 0); // WHEN emit timerControl->timerFinished(); // THEN QCOMPARE(timerControl->model(), control->currentTimer()); QCOMPARE(timerControl->model(), control->model().at(2)); QCOMPARE(control->remaining(), 2); QCOMPARE(remainingSpy->size(), 1); QCOMPARE(remainingSpy->takeFirst().first().toInt(), 2); QCOMPARE(currentTimerSpy->size(), 1); QCOMPARE(currentTimerSpy->takeFirst().first().value(), control->model().at(2)); QCOMPARE(finishedSpy->size(), 0); // WHEN control->nextTimer(); // THEN QCOMPARE(timerControl->model(), control->currentTimer()); QCOMPARE(timerControl->model(), control->model().at(3)); QCOMPARE(control->remaining(), 1); QCOMPARE(remainingSpy->size(), 1); QCOMPARE(remainingSpy->takeFirst().first().toInt(), 1); QCOMPARE(currentTimerSpy->size(), 1); QCOMPARE(currentTimerSpy->takeFirst().first().value(), control->model().at(3)); QCOMPARE(finishedSpy->size(), 0); // WHEN control->nextTimer(); // THEN QCOMPARE(timerControl->model(), control->currentTimer()); QCOMPARE(timerControl->model(), TimerModel{}); QCOMPARE(control->remaining(), 0); QCOMPARE(remainingSpy->size(), 1); QCOMPARE(remainingSpy->takeFirst().first().toInt(), 0); QCOMPARE(currentTimerSpy->size(), 1); QCOMPARE(currentTimerSpy->takeFirst().first().value(), TimerModel{}); QCOMPARE(finishedSpy->size(), 1); } }; QTEST_MAIN(CircuitControlTest) #include "circuitcontroltest.moc" diff --git a/tests/circuitlistmodeltest.cpp b/tests/circuitlistmodeltest.cpp index 0798f05..10087fa 100644 --- a/tests/circuitlistmodeltest.cpp +++ b/tests/circuitlistmodeltest.cpp @@ -1,226 +1,211 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include #include #include "circuitlistmodel.h" static_assert(std::is_base_of::value, "Should be an item model"); class CircuitListModelTest : public QObject { Q_OBJECT private: QDir storageDir() const { auto path = QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation); return {path}; } void writeInFile(const QString &fileName, const QString &fileContent) { auto dir = storageDir(); auto file = std::make_unique(dir.path() + '/' + fileName); if (file->open(QFile::WriteOnly)) { auto stream = std::make_unique(file.get()); *stream << fileContent; } QTest::qWait(20); } void deleteFile(const QString &fileName) { QFile::remove(storageDir().path() + '/' + fileName); QTest::qWait(20); } private slots: void initTestCase() { QCoreApplication::setApplicationName("circuitlistmodeltest"); QStandardPaths::setTestModeEnabled(true); cleanupTestCase(); } void cleanupTestCase() { auto dir = storageDir(); if (dir.exists()) { dir.removeRecursively(); dir.rmpath(".."); } } void shouldHaveDefaultStateAndCreateStorageDir() { // GIVEN auto dir = storageDir(); QVERIFY(!dir.exists()); auto model = std::make_unique(); // THEN QVERIFY(dir.exists()); QCOMPARE(model->path(), dir.path()); QCOMPARE(model->rowCount(), 0); QCOMPARE(model->roleNames().value(Qt::DisplayRole), QByteArray("display")); QCOMPARE(model->roleNames().value(CircuitListModel::FilePathRole), QByteArray("filePath")); } void shouldListCircuitsInStorageDir() { // GIVEN auto model = std::make_unique(); auto spy = std::make_unique(model.get(), &CircuitListModel::modelReset); // WHEN writeInFile("foo.kairo", "---\nname: Foo Circuit\n---\n[]\n"); // THEN QCOMPARE(spy->size(), 1); QCOMPARE(model->path(), storageDir().path()); QCOMPARE(model->rowCount(), 1); QCOMPARE(model->rowCount(model->index(0, 0)), 0); QCOMPARE(model->data(model->index(0, 0)).toString(), QString("Foo Circuit")); QCOMPARE(model->data(model->index(0, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "foo.kairo"); spy->clear(); // WHEN writeInFile("ignored.json", "---\nname: Ignored file (not .kairo)\n---\n[]\n"); // THEN QCOMPARE(spy->size(), 0); QCOMPARE(model->path(), storageDir().path()); QCOMPARE(model->rowCount(), 1); QCOMPARE(model->rowCount(model->index(0, 0)), 0); QCOMPARE(model->data(model->index(0, 0)).toString(), QString("Foo Circuit")); QCOMPARE(model->data(model->index(0, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "foo.kairo"); spy->clear(); // WHEN writeInFile("bar.kairo", "---\nname: ZBar\n---\n[]\n"); // THEN QCOMPARE(spy->size(), 1); QCOMPARE(model->path(), storageDir().path()); QCOMPARE(model->rowCount(), 2); QCOMPARE(model->rowCount(model->index(0, 0)), 0); QCOMPARE(model->rowCount(model->index(1, 0)), 0); QCOMPARE(model->data(model->index(0, 0)).toString(), QString("Foo Circuit")); QCOMPARE(model->data(model->index(0, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "foo.kairo"); QCOMPARE(model->data(model->index(1, 0)).toString(), QString("ZBar")); QCOMPARE(model->data(model->index(1, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "bar.kairo"); spy->clear(); // WHEN writeInFile("zab.kairo", "---\nname: Baz Circuit\n---\n[]\n"); // THEN QCOMPARE(spy->size(), 1); QCOMPARE(model->path(), storageDir().path()); QCOMPARE(model->rowCount(), 3); QCOMPARE(model->rowCount(model->index(0, 0)), 0); QCOMPARE(model->rowCount(model->index(1, 0)), 0); QCOMPARE(model->rowCount(model->index(2, 0)), 0); QCOMPARE(model->data(model->index(0, 0)).toString(), QString("Baz Circuit")); QCOMPARE(model->data(model->index(0, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "zab.kairo"); QCOMPARE(model->data(model->index(1, 0)).toString(), QString("Foo Circuit")); QCOMPARE(model->data(model->index(1, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "foo.kairo"); QCOMPARE(model->data(model->index(2, 0)).toString(), QString("ZBar")); QCOMPARE(model->data(model->index(2, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "bar.kairo"); spy->clear(); // WHEN deleteFile("foo.kairo"); // THEN QCOMPARE(spy->size(), 1); QCOMPARE(model->path(), storageDir().path()); QCOMPARE(model->rowCount(), 2); QCOMPARE(model->rowCount(model->index(0, 0)), 0); QCOMPARE(model->rowCount(model->index(1, 0)), 0); QCOMPARE(model->data(model->index(0, 0)).toString(), QString("Baz Circuit")); QCOMPARE(model->data(model->index(0, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "zab.kairo"); QCOMPARE(model->data(model->index(1, 0)).toString(), QString("ZBar")); QCOMPARE(model->data(model->index(1, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "bar.kairo"); spy->clear(); // WHEN deleteFile("bar.kairo"); // THEN QCOMPARE(spy->size(), 1); QCOMPARE(model->path(), storageDir().path()); QCOMPARE(model->rowCount(), 1); QCOMPARE(model->rowCount(model->index(0, 0)), 0); QCOMPARE(model->data(model->index(0, 0)).toString(), QString("Baz Circuit")); QCOMPARE(model->data(model->index(0, 0), CircuitListModel::FilePathRole).toString(), storageDir().path() + '/' + "zab.kairo"); spy->clear(); // WHEN deleteFile("zab.kairo"); // THEN QCOMPARE(spy->size(), 1); QCOMPARE(model->path(), storageDir().path()); QCOMPARE(model->rowCount(), 0); spy->clear(); } void shouldLoadCircuits() { // GIVEN auto model = std::make_unique(); writeInFile("foo.kairo", "---\nname: Foo Circuit\n---\n[{\"text\": \"foo\"},{\"text\": \"foo\", \"duration\": 800}]\n"); writeInFile("bar.kairo", "---\nname: Bar Circuit\n---\n[{\"text\": \"bar\", \"duration\": 4000},{\"text\": \"bar\"}]\n"); // WHEN auto circuit = model->loadCircuit(0); // THEN auto expected = CircuitModel{"Bar Circuit",{{"bar", 4000}, {"bar"}}}; QCOMPARE(circuit, expected); // WHEN circuit = model->loadCircuit(1); // THEN expected = CircuitModel{"Foo Circuit",{{"foo"}, {"foo", 800}}}; QCOMPARE(circuit, expected); } }; QTEST_MAIN(CircuitListModelTest) #include "circuitlistmodeltest.moc" diff --git a/tests/circuitmodeltest.cpp b/tests/circuitmodeltest.cpp index d53d132..6a92631 100644 --- a/tests/circuitmodeltest.cpp +++ b/tests/circuitmodeltest.cpp @@ -1,166 +1,151 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include #include "circuitmodel.h" static_assert(std::is_copy_assignable::value, "Should be copy assignable"); static_assert(std::is_copy_constructible::value, "Should be copy constructible"); static_assert(std::is_move_assignable::value, "Should be move assignable"); static_assert(std::is_move_constructible::value, "Should be move constructible"); class CircuitModelTest : public QObject { Q_OBJECT private slots: void shouldHaveDefaultState() { // GIVEN auto model = CircuitModel{}; // THEN QCOMPARE(model.name(), QString()); QCOMPARE(model.isEmpty(), true); QCOMPARE(model.size(), 0); } void shouldBeConstructibleFromVector() { // GIVEN const auto models = QVector{ {"run"}, {"rest", 10}, {"rest", 20} }; const auto model = CircuitModel{"foo", models}; // THEN QCOMPARE(model.name(), QString("foo")); QCOMPARE(model.isEmpty(), false); QCOMPARE(model.size(), 3); QCOMPARE(model.at(0), models.at(0)); QCOMPARE(model.at(1), models.at(1)); QCOMPARE(model.at(2), models.at(2)); } void shouldBeConstructibleFromInitializerList() { // GIVEN const auto models = QVector{ {"run"}, {"rest", 10}, {"rest", 20} }; const auto model = CircuitModel{ "foo", { {"run"}, {"rest", 10}, {"rest", 20} } }; // THEN QCOMPARE(model.name(), QString("foo")); QCOMPARE(model.isEmpty(), false); QCOMPARE(model.size(), 3); QCOMPARE(model.at(0), models.at(0)); QCOMPARE(model.at(1), models.at(1)); QCOMPARE(model.at(2), models.at(2)); } void shouldBeCopyable() { // GIVEN auto model = CircuitModel{ "baz", { {"rest", 10000} } }; // WHEN model = CircuitModel{ "bleh", { {"foo", 5000}, {"bar"} } }; // THEN QCOMPARE(model.name(), QString("bleh")); QCOMPARE(model.isEmpty(), false); QCOMPARE(model.size(), 2); QCOMPARE(model.at(0).text(), QString("foo")); QCOMPARE(model.at(0).duration(), 5000); QCOMPARE(model.at(1).text(), QString("bar")); QCOMPARE(model.at(1).duration(), 0); } void shouldBeComparable() { // GIVEN auto model1 = CircuitModel{ "foo", { {"rest", 10000} } }; auto model2 = CircuitModel{ "foo", { {"rest", 10000} } }; auto model3 = CircuitModel{ "foo", { {"foo", 5000}, {"bar"} } }; auto model4 = CircuitModel{ "bar", { {"foo", 5000}, {"bar"} } }; // THEN QCOMPARE((model1 == model2), true); QCOMPARE((model1 != model2), false); QCOMPARE((model1 == model3), false); QCOMPARE((model1 != model3), true); QCOMPARE((model1 == model3), false); QCOMPARE((model1 != model3), true); QCOMPARE((model3 == model4), false); QCOMPARE((model3 != model4), true); } }; QTEST_APPLESS_MAIN(CircuitModelTest) #include "circuitmodeltest.moc" diff --git a/tests/circuitreadertest.cpp b/tests/circuitreadertest.cpp index 423ab0a..bbcb4b9 100644 --- a/tests/circuitreadertest.cpp +++ b/tests/circuitreadertest.cpp @@ -1,311 +1,296 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include #include #include #include #include "circuitreader.h" static_assert(!std::is_copy_assignable::value, "Should not be copy assignable"); static_assert(!std::is_copy_constructible::value, "Should not be copy constructible"); static_assert(std::is_move_assignable::value, "Should be move assignable"); static_assert(std::is_move_constructible::value, "Should be move constructible"); class CircuitReaderTest : public QObject { Q_OBJECT private: std::unique_ptr convertToDevice(const QString &fileContent) { auto buffer = new QBuffer; Q_ASSERT(buffer->open(QIODevice::WriteOnly)); auto stream = std::make_unique(buffer); *stream << fileContent; buffer->close(); return std::unique_ptr{buffer}; } private slots: void shouldHaveDefaultState() { // GIVEN auto reader = CircuitReader{}; // THEN QCOMPARE(reader.device(), static_cast(nullptr)); QVERIFY(reader.readMetaData().isEmpty()); QVERIFY(reader.readCircuit().isEmpty()); // WHEN auto buffer = std::make_unique(); reader = CircuitReader{buffer.get()}; // THEN QCOMPARE(reader.device(), buffer.get()); QVERIFY(reader.readMetaData().isEmpty()); QVERIFY(reader.readCircuit().isEmpty()); } void shouldDecodeDeviceContent_data() { QTest::addColumn("content"); QTest::addColumn("expectedMetaData"); QTest::addColumn("expectedCircuit"); QStringList content; QTest::newRow("empty") << content.join('\n') << CircuitReader::MetaData{} << CircuitModel{}; content.clear(); content << "---" << "author: John Doe" << "revision: 42" << "---"; QTest::newRow("header only") << content.join('\n') << CircuitReader::MetaData{ {"author", "John Doe"}, {"revision", 42} } << CircuitModel{}; content.clear(); content << "---" << "author: John Doe" << "" << "revision: 42"; QTest::newRow("header only no end mark") << content.join('\n') << CircuitReader::MetaData{} << CircuitModel{}; content.clear(); content << "author: John Doe" << "" << "revision: 42" << "---"; QTest::newRow("header only no begin mark") << content.join('\n') << CircuitReader::MetaData{} << CircuitModel{}; content.clear(); content << "---" << "author: John Doe" << "revision: 42" << "name: HIIT" << "---"; QTest::newRow("header only with name") << content.join('\n') << CircuitReader::MetaData{ {"author", "John Doe"}, {"name", "HIIT"}, {"revision", 42} } << CircuitModel{"HIIT", {}}; content.clear(); content << "[" << " {" << " \"text\": \"foo\"," << " \"duration\": 4000" << " }," << " {" << " \"text\": \"bar\"" << " }" << "]"; QTest::newRow("json only") << content.join('\n') << CircuitReader::MetaData{} << CircuitModel{}; content.clear(); content << "---" << "---" << "[" << " {" << " \"text\": \"bar\"" << " }," << " {" << " \"text\": \"foo\"," << " \"duration\": 4000" << " }" << "]"; QTest::newRow("empty header") << content.join('\n') << CircuitReader::MetaData{} << CircuitModel{ {}, { {"bar"}, {"foo", 4000}, } }; content.clear(); content << "---" << "author: John Doe" << "revision: 42" << "name: HIIT" << "---" << "[" << " {" << " \"text\": \"foo\"," << " \"duration\": 4000" << " }," << " {" << " \"text\": \"bar\"" << " }" << "]"; QTest::newRow("complete") << content.join('\n') << CircuitReader::MetaData{ {"author", "John Doe"}, {"name", "HIIT"}, {"revision", 42} } << CircuitModel{ "HIIT", { {"foo", 4000}, {"bar"} } }; content.clear(); content << "---" << "author: John Doe" << "revision: 42" << "name: HIIT" << "---" << "[" << " {" << " \"text\": \"foo\"," << " \"duration\": 4000" << " }," << " {" << " \"text\": \"One Loop\"," << " \"count\": 3," << " \"content\": [" << " {" << " \"text\": \"bar\"" << " }," << " {" << " \"text\": \"baz\"," << " \"duration\": 500" << " }" << " ]" << " }," << " {" << " \"text\": \"bleh\"" << " }," << " {" << " \"count\": 4," << " \"removeLast\": true," << " \"content\": [" << " {" << " \"text\": \"baz\"" << " }," << " {" << " \"text\": \"bar\"," << " \"duration\": 400" << " }" << " ]" << " }" << "]"; QTest::newRow("complete with loops") << content.join('\n') << CircuitReader::MetaData{ {"author", "John Doe"}, {"name", "HIIT"}, {"revision", 42} } << CircuitModel{ "HIIT", { {"foo", 4000}, {"One Loop, bar (1/3)"}, {"One Loop, baz (1/3)", 500}, {"One Loop, bar (2/3)"}, {"One Loop, baz (2/3)", 500}, {"One Loop, bar (3/3)"}, {"One Loop, baz (3/3)", 500}, {"bleh"}, {"baz (1/4)"}, {"bar (1/4)", 400}, {"baz (2/4)"}, {"bar (2/4)", 400}, {"baz (3/4)"}, {"bar (3/4)", 400}, {"baz (4/4)"} } }; } void shouldDecodeDeviceContent() { // GIVEN QFETCH(QString, content); QFETCH(CircuitReader::MetaData, expectedMetaData); QFETCH(CircuitModel, expectedCircuit); auto device = convertToDevice(content); auto reader = CircuitReader{device.get()}; // WHEN auto metaData = reader.readMetaData(); // THEN QCOMPARE(reader.device(), device.get()); QCOMPARE(metaData, expectedMetaData); if (!content.isEmpty()) { QVERIFY(device->pos() != 0); } // WHEN auto circuit = reader.readCircuit(); // THEN QCOMPARE(circuit, expectedCircuit); QVERIFY(device->atEnd()); // Now try circuit first, then metadata // GIVEN device = convertToDevice(content); reader = CircuitReader{device.get()}; // WHEN circuit = reader.readCircuit(); metaData = reader.readMetaData(); // THEN QCOMPARE(reader.device(), device.get()); QCOMPARE(metaData, expectedMetaData); QCOMPARE(circuit, expectedCircuit); QVERIFY(device->atEnd()); } }; QTEST_APPLESS_MAIN(CircuitReaderTest) #include "circuitreadertest.moc" diff --git a/tests/timercontroltest.cpp b/tests/timercontroltest.cpp index a653f88..c09692e 100644 --- a/tests/timercontroltest.cpp +++ b/tests/timercontroltest.cpp @@ -1,353 +1,338 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include #include #include #include "timercontrol.h" class TimerControlTest : public QObject { Q_OBJECT private slots: void shouldHaveDefaultState() { // GIVEN auto control = std::make_unique(); // THEN QCOMPARE(control->model(), TimerModel{}); QCOMPARE(control->text(), QString()); QCOMPARE(control->value(), 0); QCOMPARE(control->formattedValue(), QStringLiteral("00:00.0")); QCOMPARE(control->duration(), -1); QCOMPARE(control->isRunning(), false); } void shouldDeriveValuesFromModel_data() { QTest::addColumn("model"); QTest::addColumn("expectedText"); QTest::addColumn("expectedValue"); QTest::addColumn("expectedFormattedValue"); QTest::addColumn("expectedDuration"); QTest::newRow("invalid") << TimerModel{} << QString() << 0 << QStringLiteral("00:00.0") <<-1; QTest::newRow("countdown") << TimerModel{"foo", 10000} << "foo" << 10000 << QStringLiteral("00:10.0") << 10000; QTest::newRow("countdown") << TimerModel{"baz", 1050300} << "baz" << 1050300 << QStringLiteral("17:30.3") << 1050300; QTest::newRow("countdown") << TimerModel{"baz", 34570900} << "baz" << 34570900 << QStringLiteral("576:10.9") << 34570900; QTest::newRow("stopwatch") << TimerModel{"bar"} << "bar" << 0 << QStringLiteral("00:00.0") << 0; } void shouldDeriveValuesFromModel() { // GIVEN auto control = std::make_unique(); auto modelSpy = std::make_unique(control.get(), &TimerControl::modelChanged); auto textSpy = std::make_unique(control.get(), &TimerControl::textChanged); auto valueSpy = std::make_unique(control.get(), &TimerControl::valueChanged); auto durationSpy = std::make_unique(control.get(), &TimerControl::durationChanged); QFETCH(TimerModel, model); QFETCH(QString, expectedText); QFETCH(int, expectedValue); QFETCH(QString, expectedFormattedValue); QFETCH(int, expectedDuration); // WHEN control->setModel(model); // THEN QCOMPARE(control->model(), model); QCOMPARE(control->text(), expectedText); QCOMPARE(control->value(), expectedValue); QCOMPARE(control->formattedValue(), expectedFormattedValue); QCOMPARE(control->duration(), expectedDuration); if (model.isValid()) { QCOMPARE(modelSpy->size(), 1); QCOMPARE(modelSpy->takeFirst().first().value(), model); QCOMPARE(textSpy->size(), 1); QCOMPARE(textSpy->takeFirst().first().toString(), expectedText); if (model.duration() >= 0) { QCOMPARE(durationSpy->size(), 1); QCOMPARE(durationSpy->takeFirst().first().toInt(), expectedDuration); } else { QCOMPARE(durationSpy->size(), 0); } if (model.duration() != 0) { QCOMPARE(valueSpy->size(), 1); QCOMPARE(valueSpy->takeFirst().first().toInt(), expectedValue); } else { QCOMPARE(valueSpy->size(), 0); } } else { QCOMPARE(textSpy->size(), 0); QCOMPARE(valueSpy->size(), 0); QCOMPARE(durationSpy->size(), 0); } // WHEN control->setModel(model); // THEN QCOMPARE(textSpy->size(), 0); QCOMPARE(valueSpy->size(), 0); QCOMPARE(durationSpy->size(), 0); } void shouldDeriveValuesFromMovedModel_data() { shouldDeriveValuesFromModel_data(); } void shouldDeriveValuesFromMovedModel() { // GIVEN auto control = std::make_unique(); auto textSpy = std::make_unique(control.get(), &TimerControl::textChanged); auto valueSpy = std::make_unique(control.get(), &TimerControl::valueChanged); auto durationSpy = std::make_unique(control.get(), &TimerControl::durationChanged); QFETCH(TimerModel, model); QFETCH(QString, expectedText); QFETCH(int, expectedValue); QFETCH(QString, expectedFormattedValue); QFETCH(int, expectedDuration); // WHEN auto copy = model; control->setModel(std::move(copy)); // This should move it in place // THEN QCOMPARE(control->model(), model); QCOMPARE(control->text(), expectedText); QCOMPARE(control->value(), expectedValue); QCOMPARE(control->formattedValue(), expectedFormattedValue); QCOMPARE(control->duration(), expectedDuration); if (model.isValid()) { QCOMPARE(textSpy->size(), 1); QCOMPARE(textSpy->takeFirst().first().toString(), expectedText); if (model.duration() >= 0) { QCOMPARE(durationSpy->size(), 1); QCOMPARE(durationSpy->takeFirst().first().toInt(), expectedDuration); } else { QCOMPARE(durationSpy->size(), 0); } if (model.duration() != 0) { QCOMPARE(valueSpy->size(), 1); QCOMPARE(valueSpy->takeFirst().first().toInt(), expectedValue); } else { QCOMPARE(valueSpy->size(), 0); } } else { QCOMPARE(textSpy->size(), 0); QCOMPARE(valueSpy->size(), 0); } // WHEN control->setModel(std::move(model)); // THEN QCOMPARE(textSpy->size(), 0); QCOMPARE(valueSpy->size(), 0); QCOMPARE(durationSpy->size(), 0); } void shouldDoNothingWhileRunningInvalid() { // GIVEN auto control = std::make_unique(); auto textSpy = std::make_unique(control.get(), &TimerControl::textChanged); auto valueSpy = std::make_unique(control.get(), &TimerControl::valueChanged); auto durationSpy = std::make_unique(control.get(), &TimerControl::durationChanged); auto runningSpy = std::make_unique(control.get(), &TimerControl::runningChanged); auto finishedSpy = std::make_unique(control.get(), &TimerControl::timerFinished); control->setModel(TimerModel{}); // WHEN control->setRunning(true); QTest::qWait(100); // THEN QCOMPARE(control->isRunning(), true); QCOMPARE(textSpy->size(), 0); QCOMPARE(valueSpy->size(), 0); QCOMPARE(durationSpy->size(), 0); QCOMPARE(runningSpy->size(), 1); QCOMPARE(runningSpy->takeFirst().first().toBool(), true); QCOMPARE(finishedSpy->size(), 1); } void shouldRunCountdown() { // GIVEN auto control = std::make_unique(); auto textSpy = std::make_unique(control.get(), &TimerControl::textChanged); auto valueSpy = std::make_unique(control.get(), &TimerControl::valueChanged); auto durationSpy = std::make_unique(control.get(), &TimerControl::durationChanged); auto runningSpy = std::make_unique(control.get(), &TimerControl::runningChanged); auto finishedSpy = std::make_unique(control.get(), &TimerControl::timerFinished); control->setModel(TimerModel{"rest", 100}); textSpy->clear(); valueSpy->clear(); durationSpy->clear(); // WHEN control->setRunning(true); QTest::qWait(105); // THEN QCOMPARE(control->isRunning(), true); QCOMPARE(textSpy->size(), 0); QCOMPARE(durationSpy->size(), 0); QCOMPARE(valueSpy->size(), 10); for (int value = 100; value != 0; value -= 10) { QCOMPARE(valueSpy->takeFirst().first().toInt(), value - 10); } QCOMPARE(runningSpy->size(), 1); QCOMPARE(runningSpy->takeFirst().first().toBool(), true); QCOMPARE(finishedSpy->size(), 1); } void shouldRunStopwatch() { // GIVEN auto control = std::make_unique(); auto textSpy = std::make_unique(control.get(), &TimerControl::textChanged); auto valueSpy = std::make_unique(control.get(), &TimerControl::valueChanged); auto durationSpy = std::make_unique(control.get(), &TimerControl::durationChanged); auto runningSpy = std::make_unique(control.get(), &TimerControl::runningChanged); auto finishedSpy = std::make_unique(control.get(), &TimerControl::timerFinished); control->setModel(TimerModel{"run"}); textSpy->clear(); valueSpy->clear(); durationSpy->clear(); // WHEN control->setRunning(true); QTest::qWait(105); control->setRunning(false); // THEN QCOMPARE(control->isRunning(), false); QCOMPARE(textSpy->size(), 0); QCOMPARE(durationSpy->size(), 0); QCOMPARE(valueSpy->size(), 10); for (int value = 0; value != 100; value += 10) { QCOMPARE(valueSpy->takeFirst().first().toInt(), value + 10); } QCOMPARE(runningSpy->size(), 2); QCOMPARE(runningSpy->takeFirst().first().toBool(), true); QCOMPARE(runningSpy->takeFirst().first().toBool(), false); QCOMPARE(finishedSpy->size(), 0); } void shouldKeepRunningDuringModelChanges() { // GIVEN auto control = std::make_unique(); auto textSpy = std::make_unique(control.get(), &TimerControl::textChanged); auto valueSpy = std::make_unique(control.get(), &TimerControl::valueChanged); auto durationSpy = std::make_unique(control.get(), &TimerControl::durationChanged); auto runningSpy = std::make_unique(control.get(), &TimerControl::runningChanged); auto finishedSpy = std::make_unique(control.get(), &TimerControl::timerFinished); auto skippedSpy = std::make_unique(control.get(), &TimerControl::timerSkipped); control->setModel(TimerModel{"run"}); textSpy->clear(); valueSpy->clear(); durationSpy->clear(); // WHEN control->setRunning(true); QTest::qWait(25); control->setModel(TimerModel{"rest", 100}); QTest::qWait(105); control->setModel(TimerModel{"run"}); QTest::qWait(35); control->setModel(TimerModel{"rest again", 100}); QTest::qWait(55); control->setRunning(false); // THEN QCOMPARE(control->isRunning(), false); QCOMPARE(runningSpy->size(), 2); QCOMPARE(runningSpy->takeFirst().first().toBool(), true); QCOMPARE(runningSpy->takeFirst().first().toBool(), false); QCOMPARE(textSpy->size(), 3); QCOMPARE(textSpy->takeFirst().first().toString(), QString("rest")); QCOMPARE(textSpy->takeFirst().first().toString(), QString("run")); QCOMPARE(textSpy->takeFirst().first().toString(), QString("rest again")); const auto expectedValues = QVector{10, 20, 100, 90, 80, 70, 60, 50, 40, 30, 20, 10, 0, 10, 20, 30, 100, 90, 80, 70, 60, 50}; auto values = QVector(); while (!valueSpy->isEmpty()) values << valueSpy->takeFirst().first().toInt(); qDebug() << values; qDebug() << expectedValues; QCOMPARE(values, expectedValues); const auto expectedDurations = QVector{100, 0, 100}; auto durations = QVector(); while (!durationSpy->isEmpty()) durations << durationSpy->takeFirst().first().toInt(); qDebug() << durations; qDebug() << expectedDurations; QCOMPARE(values, expectedValues); QCOMPARE(finishedSpy->size(), 1); QCOMPARE(skippedSpy->size(), 2); } void shouldCreateModels() { // GIVEN auto control = std::make_unique(); // THEN auto model = TimerModel{}; QCOMPARE(control->createModel(), model); model = TimerModel{"foo"}; QCOMPARE(control->createModel("foo"), model); model = TimerModel{"bar", 1000}; QCOMPARE(control->createModel("bar", 1000), model); } }; QTEST_MAIN(TimerControlTest) #include "timercontroltest.moc" diff --git a/tests/timermodeltest.cpp b/tests/timermodeltest.cpp index 522fcd8..50a28d2 100644 --- a/tests/timermodeltest.cpp +++ b/tests/timermodeltest.cpp @@ -1,118 +1,103 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include #include "timermodel.h" static_assert(std::is_copy_assignable::value, "Should be copy assignable"); static_assert(std::is_copy_constructible::value, "Should be copy constructible"); static_assert(std::is_move_assignable::value, "Should be move assignable"); static_assert(std::is_move_constructible::value, "Should be move constructible"); class TimerModelTest : public QObject { Q_OBJECT private slots: void initTestCase() { qRegisterMetaType(); } void shouldHaveDefaultState() { // GIVEN auto model = TimerModel{}; // THEN QCOMPARE(model.text(), QString()); QCOMPARE(model.duration(), -1); QCOMPARE(model.type(), TimerModel::Invalid); QVERIFY(!model.isValid()); } void shouldConstructCountdown() { // GIVEN auto model = TimerModel{"rest", 10000}; // THEN QCOMPARE(model.text(), QString("rest")); QCOMPARE(model.duration(), 10000); QCOMPARE(model.type(), TimerModel::Countdown); QVERIFY(model.isValid()); } void shouldConstructStopwatch() { // GIVEN auto model = TimerModel{"run"}; // THEN QCOMPARE(model.text(), QString("run")); QCOMPARE(model.duration(), 0); QCOMPARE(model.type(), TimerModel::Stopwatch); QVERIFY(model.isValid()); } void shouldBeCopyable() { // GIVEN auto model = TimerModel{"rest", 10000}; // WHEN model = TimerModel{"foo", 5000}; // THEN QCOMPARE(model.text(), QString("foo")); QCOMPARE(model.duration(), 5000); } void shouldBeComparable_data() { QTest::addColumn("model1"); QTest::addColumn("model2"); QTest::addColumn("expected"); QTest::newRow("equal") << TimerModel{"foo", 5000} << TimerModel{"foo", 5000} << true; QTest::newRow("differ by text") << TimerModel{"foo", 5000} << TimerModel{"bar", 5000} << false; QTest::newRow("differ by duration") << TimerModel{"foo", 5000} << TimerModel{"foo", 15000} << false; QTest::newRow("differ completely") << TimerModel{"foo", 5000} << TimerModel{"bar", 15000} << false; } void shouldBeComparable() { // GIVEN QFETCH(TimerModel, model1); QFETCH(TimerModel, model2); QFETCH(bool, expected); // THEN QCOMPARE((model1 == model2), expected); QCOMPARE((model1 != model2), !expected); } }; QTEST_APPLESS_MAIN(TimerModelTest) #include "timermodeltest.moc" diff --git a/tests/timernotificationcontroltest.cpp b/tests/timernotificationcontroltest.cpp index 4530e39..29ab6b4 100644 --- a/tests/timernotificationcontroltest.cpp +++ b/tests/timernotificationcontroltest.cpp @@ -1,207 +1,192 @@ /* This file is part of Kairo Timer - Copyright 2016 Kevin Ottens - - 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 2 of - the License or (at your option) version 3 or any later version - accepted by the membership of KDE e.V. (or its successor approved - by the membership of KDE e.V.), which shall act as a proxy - defined in Section 14 of version 3 of the license. - - 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, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, - USA. + SPDX-FileCopyrightText: 2016 (c) Kevin Ottens + + SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL + */ #include #include #include #include "timernotificationcontrol.h" #include "timercontrol.h" #include "soundcontrolstub.h" class TimerNotificationControlTest : public QObject { Q_OBJECT private slots: void initTestCase() { qRegisterMetaType(); qRegisterMetaType(); } void shouldHaveDefaultState() { // GIVEN auto notification = std::make_unique(); // THEN QCOMPARE(notification->sound(), static_cast(nullptr)); QCOMPARE(notification->timer(), static_cast(nullptr)); } void shouldHaveSoundControl() { // GIVEN auto notification = std::make_unique(); auto sound = new SoundControlStub(notification.get()); auto soundSpy = std::make_unique(notification.get(), &TimerNotificationControl::soundChanged); // WHEN notification->setSound(sound); // THEN QCOMPARE(notification->sound(), sound); QCOMPARE(soundSpy->size(), 1); QCOMPARE(soundSpy->takeFirst().first().value(), sound); // WHEN notification->setSound(sound); // THEN QCOMPARE(soundSpy->size(), 0); } void shouldHaveTimerControl() { // GIVEN auto notification = std::make_unique(); auto timer = new TimerControl(notification.get()); auto timerSpy = std::make_unique(notification.get(), &TimerNotificationControl::timerChanged); // WHEN notification->setTimer(timer); // THEN QCOMPARE(notification->timer(), timer); QCOMPARE(timerSpy->size(), 1); QCOMPARE(timerSpy->takeFirst().first().value(), timer); // WHEN notification->setTimer(timer); // THEN QCOMPARE(timerSpy->size(), 0); } void shouldPlayLongBeepOnTimerFinished() { // GIVEN auto notification = std::make_unique(); auto sound = new SoundControlStub(notification.get()); notification->setSound(sound); auto timer = new TimerControl(notification.get()); notification->setTimer(timer); // WHEN emit timer->timerFinished(); // THEN QCOMPARE(sound->calls().size(), 1); QCOMPARE(sound->calls().first(), SoundControlStub::LongBeep); sound->clear(); // WHEN notification->setTimer(nullptr); emit timer->timerFinished(); // THEN QVERIFY(sound->calls().isEmpty()); } void shouldPlayShortBeepOnTimerSkipped() { // GIVEN auto notification = std::make_unique(); auto sound = new SoundControlStub(notification.get()); notification->setSound(sound); auto timer = new TimerControl(notification.get()); notification->setTimer(timer); // WHEN emit timer->timerSkipped(); // THEN QCOMPARE(sound->calls().size(), 1); QCOMPARE(sound->calls().first(), SoundControlStub::ShortBeep); sound->clear(); // WHEN notification->setTimer(nullptr); emit timer->timerSkipped(); // THEN QVERIFY(sound->calls().isEmpty()); } void shouldPlayShortBeepOnLastTenCountdownPlainSecondsOnly() { // GIVEN auto notification = std::make_unique(); auto sound = new SoundControlStub(notification.get()); notification->setSound(sound); auto timer = new TimerControl(notification.get()); timer->setModel({"countdown", 50000}); notification->setTimer(timer); // WHEN emit timer->valueChanged(50000); emit timer->valueChanged(47550); emit timer->valueChanged(10100); emit timer->valueChanged(10010); emit timer->valueChanged(10000); emit timer->valueChanged(9990); emit timer->valueChanged(9010); emit timer->valueChanged(9000); emit timer->valueChanged(8990); emit timer->valueChanged(8000); emit timer->valueChanged(7000); emit timer->valueChanged(6000); emit timer->valueChanged(5000); emit timer->valueChanged(4000); emit timer->valueChanged(3000); emit timer->valueChanged(2000); emit timer->valueChanged(1000); emit timer->valueChanged(0); // THEN QCOMPARE(sound->calls().size(), 10); QCOMPARE(sound->calls().first(), SoundControlStub::ShortBeep); sound->clear(); // WHEN timer->setModel({"timer"}); emit timer->valueChanged(9000); // THEN QVERIFY(sound->calls().isEmpty()); // WHEN notification->setTimer(nullptr); emit timer->valueChanged(9000); // THEN QVERIFY(sound->calls().isEmpty()); } }; QTEST_MAIN(TimerNotificationControlTest) #include "timernotificationcontroltest.moc"