diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index f0f19fa..3ef2ae0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ # Shelf -Shelf is a simple Android App Launcher with simple gestures and productivity features. +A simple Android App Launcher with simple gestures and productivity features; that can also be fiddled with. @@ -15,9 +15,7 @@ Shelf is a simple Android App Launcher with simple gestures and productivity fea - Gestures for easy accessibility ## Screenshots -
-Shelf home screenShelf home screen   Shelf home screen -
+Shelf home screenShelf home screenShelf home screenShelf home screen ## Contributions - Welcome \ No newline at end of file diff --git a/android/app/build.gradle b/android/app/build.gradle index e8d22af..7993c0d 100644 --- a/android/app/build.gradle +++ b/android/app/build.gradle @@ -62,6 +62,13 @@ android { signingConfig = signingConfigs.release } } + + dependenciesInfo { + // Disables dependency metadata when building APKs. + includeInApk = false + // Disables dependency metadata when building Android App Bundles. + includeInBundle = false + } } flutter { diff --git a/android/app/src/main/kotlin/com/coleblvck/shelf/MainActivity.kt b/android/app/src/main/kotlin/com/coleblvck/shelf/MainActivity.kt index 0dfa717..eb83c06 100644 --- a/android/app/src/main/kotlin/com/coleblvck/shelf/MainActivity.kt +++ b/android/app/src/main/kotlin/com/coleblvck/shelf/MainActivity.kt @@ -4,6 +4,7 @@ import android.annotation.SuppressLint import android.content.Context import android.content.Intent import android.content.Intent.FLAG_ACTIVITY_NEW_TASK +import android.content.pm.PackageManager import android.net.Uri import android.os.Build import android.os.Bundle @@ -93,7 +94,7 @@ class MainActivity : FlutterActivity() { companion object { - lateinit var appContext: Context + lateinit var appContext: Context } @@ -102,11 +103,11 @@ class MainActivity : FlutterActivity() { private var appsChangeListener: DeviceAppsChangedListener? = null override fun onListen(arguments: Any?, events: EventSink?) { - if (appsChangeListener == null) { - appsChangeListener = DeviceAppsChangedListener(this) - } + if (appsChangeListener == null) { + appsChangeListener = DeviceAppsChangedListener(this) + } - appsChangeListener!!.register(appContext, events!!) + appsChangeListener!!.register(appContext, events!!) } @@ -153,12 +154,18 @@ class MainActivity : FlutterActivity() { private fun fetchApps(): List> { val packageManager = context.packageManager - val allAppsList = packageManager.queryIntentActivities( - Intent( - Intent.ACTION_MAIN, - null - ).addCategory(Intent.CATEGORY_LAUNCHER), 0 - ) + val mainIntent = Intent(Intent.ACTION_MAIN, null) + mainIntent.addCategory(Intent.CATEGORY_LAUNCHER) + val allAppsList = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) { + packageManager.queryIntentActivities( + mainIntent, + PackageManager.ResolveInfoFlags.of(0L) + ) + } else { + packageManager.queryIntentActivities( + mainIntent, 0 + ) + } val listToReturn = emptyList>().toMutableList() for (appInfo in allAppsList) { if (appInfo.activityInfo.packageName != context.packageName) { diff --git a/fastlane/metadata/android/en-US/changelogs/2.txt b/fastlane/metadata/android/en-US/changelogs/2.txt new file mode 100644 index 0000000..f2b413d --- /dev/null +++ b/fastlane/metadata/android/en-US/changelogs/2.txt @@ -0,0 +1 @@ +- UI/UX Update \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/3.txt b/fastlane/metadata/android/en-US/changelogs/3.txt new file mode 100644 index 0000000..0c60cc4 --- /dev/null +++ b/fastlane/metadata/android/en-US/changelogs/3.txt @@ -0,0 +1 @@ +- User Experience Update \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/full_description.txt b/fastlane/metadata/android/en-US/full_description.txt index cb2d329..cb9c56f 100644 --- a/fastlane/metadata/android/en-US/full_description.txt +++ b/fastlane/metadata/android/en-US/full_description.txt @@ -1,4 +1,4 @@ -Shelf is a simple Android App Launcher with simple gestures and productivity features. +Shelf is a simple Android App Launcher with simple gestures and productivity features; that can also be fiddled with. - Easy and quick noting with a single note card - Quick Web search from the App Drawer (Google) diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png b/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png index a2ea579..45ebe8e 100644 Binary files a/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png and b/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png differ diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png b/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png index 2a1ec9e..1082aaf 100644 Binary files a/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png and b/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png differ diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png b/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png index caae28d..2c6fb21 100644 Binary files a/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png and b/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png differ diff --git a/fastlane/metadata/android/en-US/images/phoneScreenshots/4.png b/fastlane/metadata/android/en-US/images/phoneScreenshots/4.png new file mode 100644 index 0000000..17a0f87 Binary files /dev/null and b/fastlane/metadata/android/en-US/images/phoneScreenshots/4.png differ diff --git a/fastlane/metadata/android/en-US/short_description.txt b/fastlane/metadata/android/en-US/short_description.txt index f3baab9..08abc3b 100644 --- a/fastlane/metadata/android/en-US/short_description.txt +++ b/fastlane/metadata/android/en-US/short_description.txt @@ -1 +1 @@ -A simple Android App Launcher. \ No newline at end of file +A simple Android App Launcher that can be fiddled with. \ No newline at end of file diff --git a/lib/custom_functions.dart b/lib/custom_functions.dart new file mode 100644 index 0000000..3720a6c --- /dev/null +++ b/lib/custom_functions.dart @@ -0,0 +1,205 @@ +import 'dart:async'; + +import 'package:flutter/material.dart'; +import 'package:mini_music_visualizer/mini_music_visualizer.dart'; +import 'package:remix_icon_icons/remix_icon_icons.dart'; +import 'package:shelf/channels/app_scout/app_scout.dart'; +import 'package:shelf/state/state_util.dart'; +import 'package:shelf/ui/theming.dart'; +import 'package:shelf/utilities/dialogs/functions_mapping.dart'; +import 'package:shelf/utilities/user_prefs.dart'; + +class WidgetKeys { + static const String visualizer = "visualizer"; + static const String music = "music"; + static const String pencil = "pencil"; + static const String firefox = "firefox"; + static const String fire = "fire"; + static const String thunderstorms = "thunderstorms"; + static const String trafficLight = "trafficLight"; + static const String lightbulb = "lightbulb"; + static const String spaceShip = "spaceShip"; + static const String chat = "chat"; + static const String chat2 = "chat2"; + static const String game = "game"; + static const String gamePad = "gamePad"; + static const String settings = "settings"; +} + +class BehaviourKeys { + static const String launch = "launch App"; + static const String action = "Action"; + static const String none = "None"; +} + +class CustomFunctions { + run(BuildContext context) async { + if (currentBehaviour == BehaviourKeys.launch && shelfState.apps.list.isNotEmpty) { + if (shelfState.apps.list + .map((e) => e.packageName) + .toList() + .contains(currentPackage)) { + AppScout.launchApp(currentPackage); + } else { + functionMappingDialog(context); + } + } + } + + updateCustomBehavior({ + String widget = "", + String package = "", + String behaviour = "", + bool save = true, + }) async { + if (widget != "") { + updateWidget(widget); + } + if (package != "") { + updatePackage(package); + } + + if (behaviour != "") { + updateAction(behaviour); + } + if (save) { + await _save( + widget: widget, + package: package, + behaviour: behaviour, + ); + } + } + + updateWidget(String widget) { + currentWidget = widget; + widgetStream.add(widgets[widget]!); + } + + updatePackage(String package) { + currentPackage = package; + } + + updateAction(String action) { + currentBehaviour = action; + widgetStream.add(widgets[currentWidget]!); + } + + _save({ + String widget = "", + String package = "", + String behaviour = "", + }) async { + if (widget != "") { + await userPrefs.setString(PrefKeys.customWidget, widget); + } + if (package != "") { + await userPrefs.setString(PrefKeys.customPackage, package); + } + if (behaviour != "") { + await userPrefs.setString(PrefKeys.customBehaviour, behaviour); + } + } + + StreamController widgetStream = StreamController.broadcast(); + String currentWidget = WidgetKeys.visualizer; + String currentPackage = "com.coleblvck.antiiq"; + String currentBehaviour = BehaviourKeys.launch; + + List functionKeys = [ + BehaviourKeys.launch, + BehaviourKeys.action, + ]; + + List widgetKeys = [ + WidgetKeys.visualizer, + WidgetKeys.music, + WidgetKeys.pencil, + WidgetKeys.firefox, + WidgetKeys.fire, + WidgetKeys.thunderstorms, + WidgetKeys.trafficLight, + WidgetKeys.lightbulb, + WidgetKeys.spaceShip, + WidgetKeys.chat, + WidgetKeys.chat2, + WidgetKeys.game, + WidgetKeys.gamePad, + WidgetKeys.settings, + ]; + + Map widgets = { + "visualizer": MiniMusicVisualizer( + animate: true, + radius: 8, + height: 24, + width: 10, + color: currentColorScheme.onPrimary, + ), + "music": Icon( + RemixIcon.music, + color: currentColorScheme.onPrimary, + size: 30, + ), + "pencil": Icon( + RemixIcon.pencil, + color: currentColorScheme.onPrimary, + size: 30, + ), + "firefox": Icon( + RemixIcon.firefox, + color: currentColorScheme.onPrimary, + size: 30, + ), + "fire": Icon( + RemixIcon.fire, + color: currentColorScheme.onPrimary, + size: 30, + ), + "thunderstorms": Icon( + RemixIcon.thunderstorms, + color: currentColorScheme.onPrimary, + size: 30, + ), + "trafficLight": Icon( + RemixIcon.traffic_light, + color: currentColorScheme.onPrimary, + size: 30, + ), + "lightbulb": Icon( + RemixIcon.lightbulb, + color: currentColorScheme.onPrimary, + size: 30, + ), + "spaceShip": Icon( + RemixIcon.space_ship, + color: currentColorScheme.onPrimary, + size: 30, + ), + "chat": Icon( + RemixIcon.chat_1, + color: currentColorScheme.onPrimary, + size: 30, + ), + "chat2": Icon( + RemixIcon.chat_3, + color: currentColorScheme.onPrimary, + size: 30, + ), + "game": Icon( + RemixIcon.game, + color: currentColorScheme.onPrimary, + size: 30, + ), + "gamePad": Icon( + RemixIcon.gamepad, + color: currentColorScheme.onPrimary, + size: 30, + ), + "settings": Icon( + RemixIcon.settings_3, + color: currentColorScheme.onPrimary, + size: 30, + ), + }; +} diff --git a/lib/global_variables.dart b/lib/global_variables.dart deleted file mode 100644 index 9482fe2..0000000 --- a/lib/global_variables.dart +++ /dev/null @@ -1,18 +0,0 @@ - -import 'package:flutter/material.dart'; -import 'package:mini_music_visualizer/mini_music_visualizer.dart'; -import 'package:shelf/ui/theming.dart'; - - -String leadingWidget = "visualizer"; -String leadingWidgetApp = "com.coleblvck.antiiq"; - -Map widgets(context) => { - "visualizer": MiniMusicVisualizer( - animate: true, - radius: 8, - height: 24, - width: 10, - color: ShelfTheme.of(context).colors.onPrimary, - ), - }; diff --git a/lib/main.dart b/lib/main.dart index 7bcbed1..af03e69 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -1,17 +1,21 @@ import 'package:flutter/material.dart'; -import 'package:shared_preferences/shared_preferences.dart'; import 'package:shelf/screens/desktop.dart'; import 'package:shelf/state/shelf_state.dart'; import 'package:shelf/state/state_util.dart'; import 'package:shelf/ui/theming.dart'; -import 'package:shelf/utilities/user_prefs.dart'; void main() async { WidgetsFlutterBinding.ensureInitialized(); + await initColorScheme(); shelfState = ShelfState(); - userPrefs = await SharedPreferences.getInstance(); await shelfState.initShelf(); - runApp(const Shelf()); + runApp( + ShelfTheme( + colors: currentColorScheme, + uiParameters: defaultUIParameters, + child: const Shelf(), + ), + ); } class Shelf extends StatelessWidget { @@ -20,27 +24,17 @@ class Shelf extends StatelessWidget { // This widget is the root of your application. @override Widget build(BuildContext context) { - return StreamBuilder( - stream: colorSchemeStream.stream, - builder: (context, snapshot) { - return ShelfTheme( - colors: snapshot.data ?? currentColorScheme!, - uiParameters: defaultUIParameters, - child: MaterialApp( - title: 'Shelf', - theme: ThemeData( - textSelectionTheme: TextSelectionThemeData( - cursorColor: currentColorScheme!.onPrimary, - selectionHandleColor: currentColorScheme!.onPrimary, - selectionColor: currentColorScheme!.onPrimary, - ), - ), - debugShowCheckedModeBanner: false, - home: const Desktop(), - ), - ); - } - ); - + return MaterialApp( + title: 'Shelf', + theme: ThemeData( + textSelectionTheme: TextSelectionThemeData( + cursorColor: ShelfTheme.of(context).colors.onPrimary, + selectionHandleColor: ShelfTheme.of(context).colors.onPrimary, + selectionColor: ShelfTheme.of(context).colors.onPrimary, + ), + ), + debugShowCheckedModeBanner: false, + home: const Desktop(), + ); } } diff --git a/lib/screens/desktop.dart b/lib/screens/desktop.dart index 32e0ecb..56f6a3d 100644 --- a/lib/screens/desktop.dart +++ b/lib/screens/desktop.dart @@ -1,4 +1,9 @@ import 'package:flutter/material.dart'; +import 'package:parallax_rain/parallax_rain.dart'; +import 'package:shelf/state/flow_state.dart'; +import 'package:shelf/state/pages_state.dart'; +import 'package:shelf/state/parallax_state.dart'; +import 'package:shelf/ui/theming.dart'; import '../state/state_util.dart'; import '../ui/dashboard/dashboard.dart'; @@ -17,70 +22,107 @@ class _DesktopState extends State { Widget build(BuildContext context) { return PopScope( canPop: false, - onPopInvoked: (didPop) => { - if (shelfState.pages.index != 1) - { - shelfState.pages.controller.animateToPage( - 1, + onPopInvoked: (didPop) { + FocusManager.instance.primaryFocus?.unfocus(); + final PagesState pages = shelfState.pages; + if (pages.currentIndex % pages.pageCount != 1) { + pages.controller.animateToPage( + pages.currentIndex <= (pages.itemCount - 1) / 2 + ? pages.currentIndex + 1 + : pages.currentIndex - 1, + curve: Curves.decelerate, + duration: const Duration(milliseconds: 200), + ); + } else { + final FlowState flow = shelfState.flow; + if (flow.currentIndex % flow.cardCount != 0) { + shelfState.flow.controller.animateToPage( + flow.currentIndex <= (flow.itemCount - 1) / 2 + ? flow.currentIndex + 1 + : flow.currentIndex - 1, curve: Curves.decelerate, - duration: const Duration(milliseconds: 300), - ), + duration: const Duration(milliseconds: 200), + ); } - else - { - if (shelfState.flow.index != 0) - { - shelfState.flow.controller.animateToPage( - 0, - curve: Curves.decelerate, - duration: const Duration(milliseconds: 300), - ), - } - }, + } }, child: Scaffold( resizeToAvoidBottomInset: false, backgroundColor: Colors.transparent, - body: SafeArea( - child: Padding( - padding: const EdgeInsets.symmetric(vertical: 8.0), - child: MediaQuery.of(context).orientation == Orientation.portrait - ? Column( - children: [ - StreamBuilder( - stream: shelfState.flow.visibilityStream.stream, - builder: (context, snapshot) { - final bool isVisible = - snapshot.data ?? shelfState.flow.visible; - return isVisible ? const ShelfFlow() : Container(); - }, - ), - ShelfPages(), - StreamBuilder( - stream: shelfState.dashboard.visibilityStream.stream, - builder: (context, snapshot) { - final bool isVisible = - snapshot.data ?? shelfState.dashboard.visible; - return isVisible ? const Dashboard() : Container(); - }, - ), - ], - ) - : Column( - children: [ - ShelfPages(), - StreamBuilder( - stream: shelfState.dashboard.visibilityStream.stream, - builder: (context, snapshot) { - final bool isVisible = - snapshot.data ?? shelfState.dashboard.visible; - return isVisible ? const Dashboard() : Container(); - }, - ), - ], + body: StreamBuilder( + stream: shelfState.parallax.statusStream.stream, + builder: (context, snapshot) { + ParallaxStatus status = + snapshot.data ?? shelfState.parallax.status; + return status != ParallaxStatus.off + ? ParallaxRain( + dropColors: [ + ShelfTheme.of(context).colors.primary, + ShelfTheme.of(context).colors.secondary, + ], + dropFallSpeed: 2, + numberOfDrops: 100, + dropWidth: 0.5, + dropHeight: 8, + trail: true, + rainIsInBackground: false, + trailStartFraction: 0.2, + numberOfLayers: 3, + distanceBetweenLayers: 2, + child: const DesktopContent(), + ) + : const DesktopContent(); + }), + ), + ); + } +} + +class DesktopContent extends StatelessWidget { + const DesktopContent({ + super.key, + }); + + @override + Widget build(BuildContext context) { + return SafeArea( + child: Padding( + padding: const EdgeInsets.symmetric(vertical: 8.0), + child: MediaQuery.of(context).orientation == Orientation.portrait + ? Column( + children: [ + StreamBuilder( + stream: shelfState.flow.visibilityStream.stream, + builder: (context, snapshot) { + final bool isVisible = + snapshot.data ?? shelfState.flow.visible; + return isVisible ? ShelfFlow() : Container(); + }, + ), + const ShelfPages(), + StreamBuilder( + stream: shelfState.dashboard.visibilityStream.stream, + builder: (context, snapshot) { + final bool isVisible = + snapshot.data ?? shelfState.dashboard.visible; + return isVisible ? const Dashboard() : Container(); + }, + ), + ], + ) + : Column( + children: [ + const ShelfPages(), + StreamBuilder( + stream: shelfState.dashboard.visibilityStream.stream, + builder: (context, snapshot) { + final bool isVisible = + snapshot.data ?? shelfState.dashboard.visible; + return isVisible ? const Dashboard() : Container(); + }, ), - ), - ), + ], + ), ), ); } diff --git a/lib/state/app_list_state.dart b/lib/state/app_list_state.dart index f432249..6de24d7 100644 --- a/lib/state/app_list_state.dart +++ b/lib/state/app_list_state.dart @@ -13,7 +13,7 @@ class AppListState { get({bool forceUpdate = false}) async { List apps = await AppScout.fetchApps(); apps.sort( - (a, b) => a.name.compareTo(b.name), + (a, b) => a.name.toLowerCase().compareTo(b.name.toLowerCase()), ); apps.removeWhere((app) => app.packageName == "com.coleblvck.shelf"); if (!forceUpdate) { diff --git a/lib/state/flow_state.dart b/lib/state/flow_state.dart index 18bc243..06fc13e 100644 --- a/lib/state/flow_state.dart +++ b/lib/state/flow_state.dart @@ -1,25 +1,43 @@ import 'dart:async'; - import 'package:flutter/material.dart'; import 'package:shelf/utilities/user_prefs.dart'; +import 'package:shelf/ui/flow/flow.dart'; class FlowState { - PageController controller = PageController(initialPage: 0); + int initialPage = 4; + int itemCount = 9; + late int cardCount; + late int currentIndex; + late PageController controller; + StreamController indexStream = StreamController.broadcast(); + List cards = const [ + HeaderCard(), + NoteCard(), + ]; - int index = 0; + init() { + currentIndex = initialPage; + controller = PageController(initialPage: initialPage); + cardCount = cards.length; + } - StreamController indexStream = StreamController.broadcast(); + onPageChanged(int index) { + currentIndex = index; + indexStream.add(index); + } goToQuickNote() async { if (!visible) { - toggleVisibility(); - await Future.delayed(const Duration(milliseconds: 100)); + await toggleVisibility(); + //await Future.delayed(const Duration(milliseconds: 100)); } - controller.page != 1 + currentIndex % cardCount != 1 ? controller.animateToPage( - 1, + currentIndex <= (itemCount - 1) / 2 + ? currentIndex + 1 + : currentIndex - 1, curve: Curves.linear, - duration: const Duration(milliseconds: 300), + duration: const Duration(milliseconds: 200), ) : null; } @@ -52,6 +70,8 @@ class FlowState { updateVisibility(bool isVisible, {bool save = true}) async { visible = isVisible; visibilityStream.add(isVisible); + controller.dispose(); + controller = PageController(initialPage: currentIndex); if (save) { await _save(isVisible); } @@ -61,7 +81,7 @@ class FlowState { await userPrefs.setBool(PrefKeys.flowVisible, isVisible); } - toggleVisibility() { - updateVisibility(!visible); + toggleVisibility() async { + await updateVisibility(!visible); } } diff --git a/lib/state/pages_state.dart b/lib/state/pages_state.dart index 43ed7c4..cc28209 100644 --- a/lib/state/pages_state.dart +++ b/lib/state/pages_state.dart @@ -1,25 +1,36 @@ import 'dart:async'; - import 'package:flutter/material.dart'; +import 'package:shelf/ui/pages/drawer.dart'; +import 'package:shelf/ui/pages/pages.dart'; class PagesState { - PageController controller = PageController(initialPage: 1); + int initialPage = 5; + int itemCount = 9; + late int pageCount; + late int currentIndex; + late PageController controller; + StreamController indexStream = StreamController.broadcast(); + List pages = const [ + ShelfDrawer(), + GestureBox(), + ]; - int index = 1; + init() { + currentIndex = initialPage; + controller = PageController(initialPage: initialPage); + pageCount = pages.length; + } - StreamController indexStream = StreamController.broadcast(); + onPageChanged(int index) { + currentIndex = index; + indexStream.add(index); + } togglePages() { - controller.page == 1 - ? controller.animateToPage( - 0, - curve: Curves.linear, - duration: const Duration(milliseconds: 300), - ) - : controller.animateToPage( - 1, - curve: Curves.linear, - duration: const Duration(milliseconds: 300), - ); + controller.animateToPage( + currentIndex <= (itemCount - 1) / 2 ? currentIndex + 1 : currentIndex - 1, + curve: Curves.linear, + duration: const Duration(milliseconds: 200), + ); } } diff --git a/lib/state/parallax_state.dart b/lib/state/parallax_state.dart new file mode 100644 index 0000000..cfd1a9a --- /dev/null +++ b/lib/state/parallax_state.dart @@ -0,0 +1,32 @@ +import 'dart:async'; + +import '../utilities/user_prefs.dart'; + +enum ParallaxStatus { falling, off } + +class ParallaxState { + ParallaxStatus status = ParallaxStatus.off; + StreamController statusStream = StreamController.broadcast(); + + setStatus(ParallaxStatus value, {bool save = true}) async { + status = value; + statusStream.add(value); + if (save) { + await _save(value); + } + } + + _save(ParallaxStatus value) async { + bool toSave = value == ParallaxStatus.off ? false : true; + await userPrefs.setBool(PrefKeys.parallaxStatus, toSave); + } + + toggleStatus() { + switch (status) { + case ParallaxStatus.off: + setStatus(ParallaxStatus.falling); + case ParallaxStatus.falling: + setStatus(ParallaxStatus.off); + } + } +} diff --git a/lib/state/shelf_state.dart b/lib/state/shelf_state.dart index 64bcbdb..ffaa6a9 100644 --- a/lib/state/shelf_state.dart +++ b/lib/state/shelf_state.dart @@ -1,14 +1,15 @@ +import 'package:shared_preferences/shared_preferences.dart'; import 'package:shelf/channels/app_scout/app_scout.dart'; +import 'package:shelf/custom_functions.dart'; import 'package:shelf/state/drawer_state.dart'; import 'package:shelf/state/flow_state.dart'; import 'package:shelf/state/pages_state.dart'; +import 'package:shelf/state/parallax_state.dart'; import 'package:shelf/state/search_state.dart'; import 'package:shelf/state/system_ui_mode_state.dart'; import 'package:shelf/utilities/user_prefs.dart'; - -import '../ui/theming.dart'; -import 'app_list_state.dart'; -import 'dashboard_state.dart'; +import 'package:shelf/state/app_list_state.dart'; +import 'package:shelf/state/dashboard_state.dart'; class ShelfState { AppListState apps = AppListState(); @@ -18,6 +19,8 @@ class ShelfState { DrawerState drawer = DrawerState(); SearchState search = SearchState(); FlowState flow = FlowState(); + ParallaxState parallax = ParallaxState(); + CustomFunctions functions = CustomFunctions(); refreshShelf({bool forceUpdate = false}) async { //await refreshColorScheme(); @@ -25,7 +28,9 @@ class ShelfState { } initShelf() async { - await initColorScheme(); + pages.init(); + flow.init(); + userPrefs = await SharedPreferences.getInstance(); initUserPrefs(); initApps(); } @@ -37,6 +42,16 @@ class ShelfState { final String? greetingText = userPrefs.getString(PrefKeys.greetingText); final String? quickNoteText = userPrefs.getString(PrefKeys.quickNoteText); final String? drawerLayout = userPrefs.getString(PrefKeys.drawerLayout); + final bool? parallaxStatus = userPrefs.getBool(PrefKeys.parallaxStatus); + final String? customWidget = userPrefs.getString(PrefKeys.customWidget); + final String? customPackage = userPrefs.getString(PrefKeys.customPackage); + final String? customBehaviour = userPrefs.getString(PrefKeys.customBehaviour); + functions.updateCustomBehavior( + widget: customWidget ?? "", + package: customPackage ?? "", + behaviour: customBehaviour ?? "", + save: false, + ); if (flowVisible != null) { flow.updateVisibility(flowVisible, save: false); } @@ -54,6 +69,11 @@ class ShelfState { if (drawerLayout != null) { drawer.updateLayout(drawerLayout, save: false); } + if (parallaxStatus != null) { + ParallaxStatus status = + parallaxStatus ? ParallaxStatus.falling : ParallaxStatus.off; + parallax.setStatus(status, save: false); + } } initApps() async { diff --git a/lib/ui/dashboard/dashboard.dart b/lib/ui/dashboard/dashboard.dart index 389a013..69aba66 100644 --- a/lib/ui/dashboard/dashboard.dart +++ b/lib/ui/dashboard/dashboard.dart @@ -1,13 +1,11 @@ import 'package:flutter/material.dart'; import 'package:remix_icon_icons/remix_icon_icons.dart'; import 'package:shelf/utilities/dialogs/drawer_layout.dart'; - -import '../../channels/app_scout/app_detail.dart'; -import '../../channels/app_scout/app_scout.dart'; -import '../../global_variables.dart'; -import '../../state/state_util.dart'; -import '../../utilities/clock.dart'; -import '../theming.dart'; +import 'package:shelf/utilities/dialogs/functions_mapping.dart'; +import 'package:shelf/custom_functions.dart'; +import 'package:shelf/state/state_util.dart'; +import 'package:shelf/utilities/clock.dart'; +import 'package:shelf/ui/theming.dart'; class Dashboard extends StatelessWidget { const Dashboard({ @@ -18,118 +16,133 @@ class Dashboard extends StatelessWidget { Widget build(BuildContext context) { return Padding( padding: const EdgeInsets.symmetric(horizontal: 8.0), - child: Card( - elevation: ShelfTheme.of(context).uiParameters.cardElevation, - color: ShelfTheme.of(context) - .colors - .primary - .withAlpha(ShelfTheme.of(context).uiParameters.cardAlpha), - child: Padding( - padding: const EdgeInsets.all(8.0), - child: Row( - mainAxisAlignment: MainAxisAlignment.start, - crossAxisAlignment: CrossAxisAlignment.center, - children: [ - const Expanded( - child: Row( - mainAxisAlignment: MainAxisAlignment.start, - crossAxisAlignment: CrossAxisAlignment.center, - children: [ - TimeWidget(), - ], + child: GestureDetector( + behavior: HitTestBehavior.translucent, + onHorizontalDragEnd: (details) { + if (details.primaryVelocity! < -200 ) { + if (shelfState.functions.currentBehaviour != BehaviourKeys.none) { + shelfState.functions.run(context); + } else { + functionMappingDialog(context); + } + } + }, + child: Card( + elevation: ShelfTheme.of(context).uiParameters.cardElevation, + color: ShelfTheme.of(context) + .colors + .primary + .withAlpha(ShelfTheme.of(context).uiParameters.cardAlpha), + child: Padding( + padding: const EdgeInsets.all(8.0), + child: Row( + mainAxisAlignment: MainAxisAlignment.start, + crossAxisAlignment: CrossAxisAlignment.center, + children: [ + const Expanded( + child: Row( + mainAxisAlignment: MainAxisAlignment.start, + crossAxisAlignment: CrossAxisAlignment.center, + children: [ + TimeWidget(), + ], + ), + ), + GestureDetector( + onTap: () { + shelfState.flow.goToQuickNote(); + }, + child: Icon( + RemixIcon.pen_nib, + color: ShelfTheme.of(context).colors.onPrimary, + size: 30, + ), + ), + const SizedBox( + width: 8, + ), + GestureDetector( + onTap: () { + shelfState.flow.toggleVisibility(); + }, + child: StreamBuilder( + stream: shelfState.flow.visibilityStream.stream, + builder: (context, snapshot) { + final bool isVisible = + snapshot.data ?? shelfState.flow.visible; + return isVisible + ? Icon( + RemixIcon.eye_2, + color: ShelfTheme.of(context).colors.onPrimary, + size: 30, + ) + : Icon( + RemixIcon.eye_close, + color: ShelfTheme.of(context).colors.onPrimary, + size: 30, + ); + }, + ), ), - ), - GestureDetector( - onTap: () { - shelfState.flow.goToQuickNote(); - }, - child: Icon( - RemixIcon.pen_nib, - color: ShelfTheme.of(context).colors.onPrimary, - size: 30, + const SizedBox( + width: 8, ), - ), - const SizedBox( - width: 8, - ), - GestureDetector( - onTap: () { - shelfState.flow.toggleVisibility(); - }, - child: StreamBuilder( - stream: shelfState.flow.visibilityStream.stream, + StreamBuilder( + stream: shelfState.functions.widgetStream.stream, builder: (context, snapshot) { - final bool isVisible = - snapshot.data ?? shelfState.flow.visible; - return isVisible - ? Icon( - RemixIcon.eye_2, - color: ShelfTheme.of(context).colors.onPrimary, - size: 30, + final CustomFunctions functions = shelfState.functions; + final String widgetKey = functions.currentWidget; + final Widget widget = + snapshot.data ?? shelfState.functions.widgets[widgetKey]!; + return functions.currentBehaviour != BehaviourKeys.none + ? Row( + children: [ + GestureDetector( + behavior: HitTestBehavior.translucent, + onTap: () { + functions.run(context); + }, + onLongPress: () { + functionMappingDialog(context); + }, + child: widget, + ), + const SizedBox( + width: 8, + ) + ], ) - : Icon( - RemixIcon.eye_close, - color: ShelfTheme.of(context).colors.onPrimary, - size: 30, - ); + : Container(); }, ), - ), - const SizedBox( - width: 8, - ), - StreamBuilder>( - stream: shelfState.apps.stream.stream, - builder: (context, snapshot) { - final List apps = - snapshot.data ?? shelfState.apps.list; - return apps - .map((app) => app.packageName) - .contains(leadingWidgetApp) - ? Row( - children: [ - GestureDetector( - behavior: HitTestBehavior.translucent, - onTap: () { - AppScout.launchApp(leadingWidgetApp); - }, - child: widgets(context)[leadingWidget], - ), - const SizedBox( - width: 8, + StreamBuilder( + stream: shelfState.pages.indexStream.stream, + builder: (context, snapshot) { + final int appDrawerIndex = + snapshot.data ?? shelfState.pages.currentIndex; + return GestureDetector( + onTap: () { + shelfState.pages.togglePages(); + }, + onLongPress: () { + drawerLayoutDialog(context); + }, + child: appDrawerIndex % 2 != 1 + ? Icon( + RemixIcon.dashboard, + color: ShelfTheme.of(context).colors.onPrimary, + size: 30, ) - ], - ) - : Container(); - }, - ), - StreamBuilder( - stream: shelfState.pages.indexStream.stream, - builder: (context, snapshot) { - final int appDrawerIndex = - snapshot.data ?? shelfState.pages.index; - return GestureDetector( - onTap: () { - shelfState.pages.togglePages(); - }, - onLongPress: () { - drawerLayoutDialog(context); - }, - child: appDrawerIndex != 1 - ? Icon( - RemixIcon.dashboard, - color: ShelfTheme.of(context).colors.onPrimary, - size: 30, - ) - : Icon( - RemixIcon.apps_2, - color: ShelfTheme.of(context).colors.onPrimary, - size: 30, - ), - ); - }, - ), - ], + : Icon( + RemixIcon.apps_2, + color: ShelfTheme.of(context).colors.onPrimary, + size: 30, + ), + ); + }, + ), + ], + ), ), ), ), diff --git a/lib/ui/flow/flow.dart b/lib/ui/flow/flow.dart index c063fda..ebb4a51 100644 --- a/lib/ui/flow/flow.dart +++ b/lib/ui/flow/flow.dart @@ -1,77 +1,100 @@ import 'package:flutter/material.dart'; +import 'package:shelf/state/flow_state.dart'; import 'package:shelf/state/state_util.dart'; - -import '../../utilities/dialogs/header_edit.dart'; -import '../../utilities/dialogs/hint.dart'; -import '../theming.dart'; +import 'package:shelf/utilities/dialogs/header_edit.dart'; +import 'package:shelf/utilities/dialogs/hint.dart'; +import 'package:shelf/ui/theming.dart'; class ShelfFlow extends StatelessWidget { - const ShelfFlow({ + ShelfFlow({ super.key, }); + final FlowState state = shelfState.flow; @override Widget build(BuildContext context) { return Expanded( flex: MediaQuery.of(context).orientation == Orientation.portrait ? 2 : 1, - child: PageView( - physics: const BouncingScrollPhysics(), - controller: shelfState.flow.controller, + child: PageView.builder( + physics: const ClampingScrollPhysics(), + pageSnapping: false, + controller: state.controller, onPageChanged: (index) { - shelfState.flow.index = index; - shelfState.flow.indexStream.add(index); + state.onPageChanged(index); }, scrollDirection: MediaQuery.of(context).orientation == Orientation.portrait ? Axis.horizontal : Axis.vertical, - children: [ - Padding( - padding: const EdgeInsets.symmetric(horizontal: 8.0), - child: GestureDetector( - onLongPress: () { - headerTextEditDialog(context); - }, - onDoubleTap: () { - showHintDialog(context); - }, - child: Card( - elevation: ShelfTheme.of(context).uiParameters.cardElevation, - color: ShelfTheme.of(context) - .colors - .secondary - .withAlpha(ShelfTheme.of(context).uiParameters.cardAlpha), - child: const Center( - child: Column( - children: [ - Expanded( - flex: 2, - child: Padding( - padding: EdgeInsets.all(8.0), - child: Center( - child: GreetingsWidget(), - ), - ), - ), - ], + itemCount: state.itemCount, + itemBuilder: (context, index) { + return state.cards[index % state.cardCount]; + }, + ), + ); + } +} + +class NoteCard extends StatelessWidget { + const NoteCard({ + super.key, + }); + + @override + Widget build(BuildContext context) { + return Padding( + padding: const EdgeInsets.symmetric(horizontal: 8.0), + child: Card( + elevation: ShelfTheme.of(context).uiParameters.cardElevation, + color: ShelfTheme.of(context) + .colors + .surface + .withAlpha(ShelfTheme.of(context).uiParameters.cardAlpha), + child: const QuickNote(), + ), + ); + } +} + +class HeaderCard extends StatelessWidget { + const HeaderCard({ + super.key, + }); + + @override + Widget build(BuildContext context) { + return Padding( + padding: const EdgeInsets.symmetric(horizontal: 8.0), + child: GestureDetector( + onLongPress: () { + headerTextEditDialog(context); + }, + onDoubleTap: () { + showHintDialog(context); + }, + child: Card( + elevation: ShelfTheme.of(context).uiParameters.cardElevation, + color: ShelfTheme.of(context) + .colors + .surface + .withAlpha(ShelfTheme.of(context).uiParameters.cardAlpha), + child: const Center( + child: Column( + children: [ + Expanded( + flex: 2, + child: Padding( + padding: EdgeInsets.all(8.0), + child: Center( + child: Greetings(), + ), ), ), - ), + ], ), ), - Padding( - padding: const EdgeInsets.symmetric(horizontal: 8.0), - child: Card( - elevation: ShelfTheme.of(context).uiParameters.cardElevation, - color: ShelfTheme.of(context) - .colors - .surface - .withAlpha(ShelfTheme.of(context).uiParameters.cardAlpha), - child: const QuickNote(), - ), - ), - ], + ), ), ); } @@ -110,8 +133,8 @@ class QuickNote extends StatelessWidget { } } -class GreetingsWidget extends StatelessWidget { - const GreetingsWidget({ +class Greetings extends StatelessWidget { + const Greetings({ super.key, }); @@ -124,9 +147,10 @@ class GreetingsWidget extends StatelessWidget { snapshot.data ?? shelfState.flow.greetingText; return Text( greetingText, - style: const TextStyle( + style: TextStyle( fontSize: 60, fontWeight: FontWeight.w900, + color: ShelfTheme.of(context).colors.onSurface, ), textAlign: TextAlign.center, ); diff --git a/lib/ui/pages/blinds.dart b/lib/ui/pages/blinds.dart index c933eec..9b0b1ff 100644 --- a/lib/ui/pages/blinds.dart +++ b/lib/ui/pages/blinds.dart @@ -14,7 +14,7 @@ class Blinds extends StatelessWidget { @override Widget build(BuildContext context) { return ListView.builder( - physics: const BouncingScrollPhysics(), + physics: const ClampingScrollPhysics(), itemCount: allApps.length, itemExtent: 60, itemBuilder: (context, index) { diff --git a/lib/ui/pages/boxes.dart b/lib/ui/pages/boxes.dart index b2265d7..30f4389 100644 --- a/lib/ui/pages/boxes.dart +++ b/lib/ui/pages/boxes.dart @@ -24,7 +24,7 @@ class Boxes extends StatelessWidget { child: Padding( padding: const EdgeInsets.all(8.0), child: CustomScrollView( - physics: const BouncingScrollPhysics(), + physics: const ClampingScrollPhysics(), slivers: [ SliverGrid.builder( gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount( diff --git a/lib/ui/pages/drawer.dart b/lib/ui/pages/drawer.dart index 46b9845..d9660cd 100644 --- a/lib/ui/pages/drawer.dart +++ b/lib/ui/pages/drawer.dart @@ -28,7 +28,7 @@ class ShelfDrawer extends StatelessWidget { elevation: ShelfTheme.of(context).uiParameters.cardElevation, color: ShelfTheme.of(context) .colors - .primary + .secondary .withAlpha(ShelfTheme.of(context).uiParameters.cardAlpha), child: Row( mainAxisAlignment: MainAxisAlignment.start, @@ -39,7 +39,7 @@ class ShelfDrawer extends StatelessWidget { child: Icon( RemixIcon.search, size: 30, - color: ShelfTheme.of(context).colors.onPrimary, + color: ShelfTheme.of(context).colors.onSecondary, ), ), Expanded( @@ -49,9 +49,10 @@ class ShelfDrawer extends StatelessWidget { decoration: const InputDecoration(border: InputBorder.none), style: TextStyle( - color: ShelfTheme.of(context).colors.onPrimary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, ), + cursorColor: ShelfTheme.of(context).colors.onSecondary, ), ), term != "" @@ -65,7 +66,7 @@ class ShelfDrawer extends StatelessWidget { RemixIcon.firefox, size: 30, color: - ShelfTheme.of(context).colors.onPrimary, + ShelfTheme.of(context).colors.onSecondary, ), ), ) @@ -79,7 +80,7 @@ class ShelfDrawer extends StatelessWidget { child: Icon( RemixIcon.close_circle, size: 30, - color: ShelfTheme.of(context).colors.onPrimary, + color: ShelfTheme.of(context).colors.onSecondary, ), ), ), diff --git a/lib/ui/pages/pages.dart b/lib/ui/pages/pages.dart index 38a8a3d..24a7432 100644 --- a/lib/ui/pages/pages.dart +++ b/lib/ui/pages/pages.dart @@ -1,35 +1,20 @@ import 'package:flutter/material.dart'; -import 'package:shelf/ui/pages/drawer.dart'; - import 'package:shelf/channels/shelf/shelf.dart'; import 'package:shelf/state/pages_state.dart'; import 'package:shelf/state/state_util.dart'; import 'package:shelf/ui/flow/flow.dart'; class ShelfPages extends StatelessWidget { - ShelfPages({ + const ShelfPages({ super.key, }); - final PagesState pagesState = shelfState.pages; - @override Widget build(BuildContext context) { return Expanded( flex: 4, child: MediaQuery.of(context).orientation == Orientation.portrait - ? PageView( - physics: const BouncingScrollPhysics(), - controller: pagesState.controller, - onPageChanged: (index) { - pagesState.index = index; - pagesState.indexStream.add(index); - }, - children: const [ - ShelfDrawer(), - GestureBox(), - ], - ) + ? PageList() : Row( children: [ StreamBuilder( @@ -37,22 +22,11 @@ class ShelfPages extends StatelessWidget { builder: (context, snapshot) { final bool isVisible = snapshot.data ?? shelfState.flow.visible; - return isVisible ? const ShelfFlow() : Container(); + return isVisible ? ShelfFlow() : Container(); }, ), Expanded( - child: PageView( - physics: const BouncingScrollPhysics(), - controller: pagesState.controller, - onPageChanged: (index) { - pagesState.indexStream.add(index); - pagesState.index = index; - }, - children: const [ - ShelfDrawer(), - GestureBox(), - ], - ), + child: PageList(), ), ], ), @@ -60,6 +34,30 @@ class ShelfPages extends StatelessWidget { } } +class PageList extends StatelessWidget { + PageList({ + super.key, + }); + + final PagesState state = shelfState.pages; + + @override + Widget build(BuildContext context) { + return PageView.builder( + physics: const ClampingScrollPhysics(), + pageSnapping: false, + controller: state.controller, + onPageChanged: (index) { + state.onPageChanged(index); + }, + itemCount: state.itemCount, + itemBuilder: (context, index) { + return state.pages[index % state.pageCount]; + }, + ); + } +} + class GestureBox extends StatelessWidget { const GestureBox({ super.key, @@ -81,6 +79,9 @@ class GestureBox extends StatelessWidget { onDoubleTap: () { shelfState.dashboard.toggleVisibility(); }, + onLongPress: () { + shelfState.parallax.toggleStatus(); + }, child: Container(), ); } diff --git a/lib/ui/pages/woven.dart b/lib/ui/pages/woven.dart index 4e093d3..56cd02f 100644 --- a/lib/ui/pages/woven.dart +++ b/lib/ui/pages/woven.dart @@ -25,7 +25,7 @@ class WovenGrid extends StatelessWidget { child: Padding( padding: const EdgeInsets.all(8.0), child: CustomScrollView( - physics: const BouncingScrollPhysics(), + physics: const ClampingScrollPhysics(), slivers: [ SliverGrid.builder( gridDelegate: SliverWovenGridDelegate.count( diff --git a/lib/ui/theming.dart b/lib/ui/theming.dart index f1864b8..6fd445a 100644 --- a/lib/ui/theming.dart +++ b/lib/ui/theming.dart @@ -1,5 +1,3 @@ -import 'dart:async'; - import 'package:dynamic_color/dynamic_color.dart'; import 'package:flutter/material.dart'; @@ -84,10 +82,7 @@ class ShelfTheme extends InheritedWidget { } } -ShelfColorScheme? currentColorScheme; - -StreamController colorSchemeStream = - StreamController.broadcast(); +late ShelfColorScheme currentColorScheme; getColorScheme() async { final corePalette = await DynamicColorPlugin.getCorePalette(); @@ -106,10 +101,8 @@ getColorScheme() async { brightness: Brightness.dark, colorSchemeType: ColorSchemeType.dynamic, ); - colorSchemeStream.add(dynamicColorScheme); currentColorScheme = dynamicColorScheme; } else { - colorSchemeStream.add(defaultColors); currentColorScheme = defaultColors; } } diff --git a/lib/utilities/dialogs/drawer_layout.dart b/lib/utilities/dialogs/drawer_layout.dart index 2db612c..23f6601 100644 --- a/lib/utilities/dialogs/drawer_layout.dart +++ b/lib/utilities/dialogs/drawer_layout.dart @@ -1,23 +1,22 @@ import 'package:flutter/material.dart'; import 'package:remix_icon_icons/remix_icon_icons.dart'; - -import '../../state/drawer_state.dart'; -import '../../state/state_util.dart'; -import '../../ui/theming.dart'; +import 'package:shelf/state/drawer_state.dart'; +import 'package:shelf/state/state_util.dart'; +import 'package:shelf/ui/theming.dart'; drawerLayoutDialog(context) { return showDialog( context: context, builder: (BuildContext context) { return AlertDialog( - backgroundColor: ShelfTheme.of(context).colors.tertiary, + backgroundColor: ShelfTheme.of(context).colors.secondary, shape: RoundedRectangleBorder(borderRadius: BorderRadius.circular(12)), title: Row( mainAxisAlignment: MainAxisAlignment.start, children: [ Icon( RemixIcon.dashboard, - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, size: 50, ), const SizedBox( @@ -26,7 +25,7 @@ drawerLayoutDialog(context) { Text( "Drawer Layout", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 24, fontWeight: FontWeight.bold), ), @@ -45,7 +44,7 @@ drawerLayoutDialog(context) { }, style: ButtonStyle( backgroundColor: WidgetStatePropertyAll( - ShelfTheme.of(context).colors.tertiary, + ShelfTheme.of(context).colors.secondary, ), shape: WidgetStatePropertyAll( RoundedRectangleBorder( @@ -60,15 +59,15 @@ drawerLayoutDialog(context) { DrawerLayout.woven, style: TextStyle( fontSize: 20, - color: ShelfTheme.of(context).colors.onTertiary), + color: ShelfTheme.of(context).colors.onSecondary), ), shelfState.drawer.layout == DrawerLayout.woven ? Checkbox( value: true, onChanged: null, - checkColor: ShelfTheme.of(context).colors.onTertiary, + checkColor: ShelfTheme.of(context).colors.onSecondary, fillColor: WidgetStatePropertyAll( - ShelfTheme.of(context).colors.tertiary, + ShelfTheme.of(context).colors.secondary, ), ) : Container() @@ -87,7 +86,7 @@ drawerLayoutDialog(context) { }, style: ButtonStyle( backgroundColor: WidgetStatePropertyAll( - ShelfTheme.of(context).colors.tertiary, + ShelfTheme.of(context).colors.secondary, ), shape: WidgetStatePropertyAll( RoundedRectangleBorder( @@ -102,15 +101,15 @@ drawerLayoutDialog(context) { DrawerLayout.boxes, style: TextStyle( fontSize: 20, - color: ShelfTheme.of(context).colors.onTertiary), + color: ShelfTheme.of(context).colors.onSecondary), ), shelfState.drawer.layout == DrawerLayout.boxes ? Checkbox( value: true, onChanged: null, - checkColor: ShelfTheme.of(context).colors.onTertiary, + checkColor: ShelfTheme.of(context).colors.onSecondary, fillColor: WidgetStatePropertyAll( - ShelfTheme.of(context).colors.tertiary, + ShelfTheme.of(context).colors.secondary, ), ) : Container() @@ -129,7 +128,7 @@ drawerLayoutDialog(context) { }, style: ButtonStyle( backgroundColor: WidgetStatePropertyAll( - ShelfTheme.of(context).colors.tertiary, + ShelfTheme.of(context).colors.secondary, ), shape: WidgetStatePropertyAll( RoundedRectangleBorder( @@ -144,15 +143,15 @@ drawerLayoutDialog(context) { DrawerLayout.blinds, style: TextStyle( fontSize: 20, - color: ShelfTheme.of(context).colors.onTertiary), + color: ShelfTheme.of(context).colors.onSecondary), ), shelfState.drawer.layout == DrawerLayout.blinds ? Checkbox( value: true, onChanged: null, - checkColor: ShelfTheme.of(context).colors.onTertiary, + checkColor: ShelfTheme.of(context).colors.onSecondary, fillColor: WidgetStatePropertyAll( - ShelfTheme.of(context).colors.tertiary, + ShelfTheme.of(context).colors.secondary, ), ) : Container() diff --git a/lib/utilities/dialogs/functions_mapping.dart b/lib/utilities/dialogs/functions_mapping.dart new file mode 100644 index 0000000..4e59b25 --- /dev/null +++ b/lib/utilities/dialogs/functions_mapping.dart @@ -0,0 +1,338 @@ +import 'package:flutter/material.dart'; +import 'package:remix_icon_icons/remix_icon_icons.dart'; +import 'package:shelf/channels/app_scout/app_detail.dart'; +import 'package:shelf/custom_functions.dart'; +import 'package:shelf/state/state_util.dart'; +import 'package:shelf/ui/theming.dart'; + +functionMappingDialog(context) { + return showDialog( + context: context, + builder: (BuildContext context) { + return AlertDialog( + backgroundColor: ShelfTheme.of(context).colors.secondary, + shape: RoundedRectangleBorder(borderRadius: BorderRadius.circular(12)), + contentPadding: const EdgeInsets.all(4.0), + title: Row( + mainAxisAlignment: MainAxisAlignment.start, + children: [ + Icon( + RemixIcon.sparkling, + color: ShelfTheme.of(context).colors.onSecondary, + size: 50, + ), + const SizedBox( + width: 8, + ), + Text( + "Custom Mapping", + style: TextStyle( + color: ShelfTheme.of(context).colors.onSecondary, + fontSize: 24, + fontWeight: FontWeight.bold), + ), + ], + ), + content: StatefulBuilder(builder: (context, set) { + return SingleChildScrollView( + child: Column( + mainAxisSize: MainAxisSize.min, + crossAxisAlignment: CrossAxisAlignment.stretch, + children: [ + Padding( + padding: const EdgeInsets.symmetric(horizontal: 12.0), + child: Text( + "Available Icons", + textAlign: TextAlign.left, + style: TextStyle( + color: ShelfTheme.of(context).colors.onSecondary, + fontSize: 20, + fontWeight: FontWeight.bold, + ), + ), + ), + SingleChildScrollView( + scrollDirection: Axis.horizontal, + child: Row( + children: [ + for (String key in shelfState.functions.widgetKeys) + GestureDetector( + onTap: () { + shelfState.functions + .updateCustomBehavior(widget: key); + set(() {}); + }, + child: Card( + shape: RoundedRectangleBorder( + borderRadius: BorderRadius.circular(12)), + color: shelfState.functions.currentWidget == key + ? ShelfTheme.of(context).colors.secondary + : ShelfTheme.of(context).colors.primary, + child: Padding( + padding: const EdgeInsets.all(12.0), + child: shelfState.functions.widgets[key], + ), + ), + ) + ], + ), + ), + const SizedBox( + height: 20, + ), + Padding( + padding: const EdgeInsets.symmetric(horizontal: 12.0), + child: Text( + "Available Functions", + textAlign: TextAlign.left, + style: TextStyle( + color: ShelfTheme.of(context).colors.onSecondary, + fontSize: 20, + fontWeight: FontWeight.bold, + ), + ), + ), + Card( + color: ShelfTheme.of(context).colors.tertiary, + child: Padding( + padding: const EdgeInsets.all(4.0), + child: Column( + mainAxisSize: MainAxisSize.min, + children: [ + Padding( + padding: const EdgeInsets.symmetric(horizontal: 4.0), + child: ElevatedButton( + style: ButtonStyle( + backgroundColor: WidgetStatePropertyAll( + shelfState.functions.currentBehaviour != + BehaviourKeys.none + ? ShelfTheme.of(context).colors.primary + : ShelfTheme.of(context).colors.secondary, + ), + shape: WidgetStatePropertyAll( + RoundedRectangleBorder( + borderRadius: BorderRadius.circular(8), + ), + ), + ), + onPressed: () { + shelfState.functions.updateCustomBehavior( + behaviour: BehaviourKeys.none); + set(() {}); + }, + child: Row( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Icon( + RemixIcon.close_circle, + color: shelfState + .functions.currentBehaviour != + BehaviourKeys.none + ? ShelfTheme.of(context).colors.onPrimary + : ShelfTheme.of(context) + .colors + .onSecondary, + size: 28, + ), + const SizedBox( + width: 10, + ), + Text( + "Do Nothing", + style: TextStyle( + fontSize: 20, + fontWeight: FontWeight.w500, + color: + shelfState.functions.currentBehaviour != + BehaviourKeys.none + ? ShelfTheme.of(context) + .colors + .onPrimary + : ShelfTheme.of(context) + .colors + .onSecondary, + ), + ), + ], + ), + ), + ), + Card( + color: ShelfTheme.of(context).colors.primary, + child: Padding( + padding: const EdgeInsets.all(8.0), + child: Column( + mainAxisSize: MainAxisSize.min, + children: [ + Row( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Icon( + RemixIcon.rocket, + color: ShelfTheme.of(context) + .colors + .onPrimary, + size: 28, + ), + const SizedBox( + width: 10, + ), + Text( + "Launch:", + style: TextStyle( + color: ShelfTheme.of(context) + .colors + .onPrimary, + fontSize: 20, + fontWeight: FontWeight.w500, + ), + ), + ], + ), + SingleChildScrollView( + scrollDirection: Axis.horizontal, + child: Row( + children: [ + for (AppDetail app + in shelfState.apps.list) + SizedBox( + width: 70, + height: 70, + child: GestureDetector( + onTap: () { + shelfState.functions + .updateCustomBehavior( + package: app.packageName, + behaviour: BehaviourKeys.launch, + ); + set(() {}); + }, + child: Card( + shape: RoundedRectangleBorder( + borderRadius: + BorderRadius.circular(8), + ), + color: app.packageName == + shelfState.functions + .currentPackage && + shelfState.functions + .currentBehaviour == + BehaviourKeys.launch + ? ShelfTheme.of(context) + .colors + .secondary + : ShelfTheme.of(context) + .colors + .surface + .withAlpha( + ShelfTheme.of(context) + .uiParameters + .cardAlpha), + child: Padding( + padding: + const EdgeInsets.all(4), + child: Column( + crossAxisAlignment: + CrossAxisAlignment.center, + children: [ + Expanded( + flex: 1, + child: Image.memory( + app.icon!)), + Padding( + padding: + const EdgeInsets.only( + top: 4.0), + child: Text( + app.name, + textAlign: + TextAlign.left, + maxLines: 1, + overflow: TextOverflow + .ellipsis, + style: TextStyle( + color: app.packageName == + shelfState + .functions + .currentPackage && + shelfState + .functions + .currentBehaviour == + BehaviourKeys + .launch + ? ShelfTheme.of( + context) + .colors + .onSecondary + : ShelfTheme.of( + context) + .colors + .primary, + fontSize: 12, + ), + ), + ), + ], + ), + ), + ), + ), + ), + ], + ), + ), + ], + ), + ), + ), + ], + ), + ), + ), + Padding( + padding: const EdgeInsets.symmetric(horizontal: 4.0), + child: ElevatedButton( + style: ButtonStyle( + backgroundColor: WidgetStatePropertyAll( + ShelfTheme.of(context).colors.primary, + ), + shape: WidgetStatePropertyAll( + RoundedRectangleBorder( + borderRadius: BorderRadius.circular(8), + ), + ), + ), + onPressed: () { + Navigator.of(context).pop(); + }, + child: Row( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Icon( + RemixIcon.check, + color: ShelfTheme.of(context).colors.onPrimary, + size: 28, + ), + const SizedBox( + width: 10, + ), + Text( + "Done", + style: TextStyle( + fontSize: 20, + color: ShelfTheme.of(context).colors.onPrimary, + fontWeight: FontWeight.bold, + ), + ), + ], + ), + ), + ), + ], + ), + ); + }), + ); + }, + ); +} diff --git a/lib/utilities/dialogs/header_edit.dart b/lib/utilities/dialogs/header_edit.dart index 3460223..19a80f6 100644 --- a/lib/utilities/dialogs/header_edit.dart +++ b/lib/utilities/dialogs/header_edit.dart @@ -11,14 +11,14 @@ headerTextEditDialog(context) { context: context, builder: (BuildContext context) { return AlertDialog( - backgroundColor: ShelfTheme.of(context).colors.tertiary, + backgroundColor: ShelfTheme.of(context).colors.secondary, shape: RoundedRectangleBorder(borderRadius: BorderRadius.circular(12)), title: Row( mainAxisAlignment: MainAxisAlignment.start, children: [ Icon( RemixIcon.sticky_note, - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, size: 50, ), const SizedBox( @@ -27,7 +27,7 @@ headerTextEditDialog(context) { Text( "Edit Header", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 24, fontWeight: FontWeight.bold), ), diff --git a/lib/utilities/dialogs/hint.dart b/lib/utilities/dialogs/hint.dart index 3c12244..07c084f 100644 --- a/lib/utilities/dialogs/hint.dart +++ b/lib/utilities/dialogs/hint.dart @@ -1,6 +1,6 @@ - import 'package:flutter/material.dart'; import 'package:remix_icon_icons/remix_icon_icons.dart'; +import 'package:shelf/state/state_util.dart'; import '../../ui/theming.dart'; @@ -14,7 +14,7 @@ showHintDialog(context) { children: [ Icon( RemixIcon.lightbulb, - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, size: 50, ), const SizedBox( @@ -23,14 +23,15 @@ showHintDialog(context) { Text( "Hints", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 24, fontWeight: FontWeight.bold), ), ], ), - backgroundColor: ShelfTheme.of(context).colors.tertiary, - shape: RoundedRectangleBorder(borderRadius: BorderRadius.circular(12)), + backgroundColor: ShelfTheme.of(context).colors.secondary, + shape: + RoundedRectangleBorder(borderRadius: BorderRadius.circular(12)), content: SingleChildScrollView( physics: const BouncingScrollPhysics(), child: Column( @@ -40,11 +41,97 @@ showHintDialog(context) { RichText( text: TextSpan( children: [ + TextSpan( + text: "- Long press on", + style: TextStyle( + color: ShelfTheme.of(context).colors.onSecondary, + fontSize: 20, + fontWeight: FontWeight.w500, + ), + ), + const WidgetSpan( + child: SizedBox( + width: 8, + ), + ), + WidgetSpan( + child: SizedBox( + width: 40, + child: shelfState.functions + .widgets[shelfState.functions.currentWidget]!, + ), + ), + const WidgetSpan( + child: SizedBox( + width: 8, + ), + ), TextSpan( text: - "- Long press on an app to open its settings page.", + "to re-map its function. If not visible, swipe left on bottom dashboard.", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, + fontSize: 20, + fontWeight: FontWeight.w500, + ), + ) + ], + ), + ), + const SizedBox( + height: 12, + ), + RichText( + text: TextSpan( + children: [ + TextSpan( + text: "- Tap on", + style: TextStyle( + color: ShelfTheme.of(context).colors.onSecondary, + fontSize: 20, + fontWeight: FontWeight.w500, + ), + ), + const WidgetSpan( + child: SizedBox( + width: 8, + ), + ), + WidgetSpan( + child: SizedBox( + width: 40, + child: shelfState.functions + .widgets[shelfState.functions.currentWidget]!, + ), + ), + const WidgetSpan( + child: SizedBox( + width: 8, + ), + ), + TextSpan( + text: + "or swipe left on bottom dashboard to run custom function. Swipe left to re-map if disabled.", + style: TextStyle( + color: ShelfTheme.of(context).colors.onSecondary, + fontSize: 20, + fontWeight: FontWeight.w500, + ), + ) + ], + ), + ), + const SizedBox( + height: 12, + ), + RichText( + text: TextSpan( + children: [ + TextSpan( + text: + "- Long press on an app to open its settings page.", + style: TextStyle( + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -59,9 +146,9 @@ showHintDialog(context) { children: [ TextSpan( text: - "- Long press on header to edit header text. Swipe left on header or tap", + "- Long press on header to edit header text. Swipe left on header or tap", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -74,7 +161,7 @@ showHintDialog(context) { child: Icon( RemixIcon.pen_nib, size: 24, - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, ), ), const WidgetSpan( @@ -83,10 +170,9 @@ showHintDialog(context) { ), ), TextSpan( - text: - "to take a quick note.", + text: "to take a quick note.", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -102,7 +188,7 @@ showHintDialog(context) { TextSpan( text: "- Tap", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -115,7 +201,7 @@ showHintDialog(context) { child: Icon( RemixIcon.eye_2, size: 24, - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, ), ), const WidgetSpan( @@ -124,9 +210,10 @@ showHintDialog(context) { ), ), TextSpan( - text: "or swipe up on empty space to show/hide header and note cards.", + text: + "or swipe up on empty space to show/hide header and note cards.", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -142,7 +229,7 @@ showHintDialog(context) { TextSpan( text: "- Tap", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -155,7 +242,7 @@ showHintDialog(context) { child: Icon( RemixIcon.firefox, size: 24, - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, ), ), const WidgetSpan( @@ -164,9 +251,10 @@ showHintDialog(context) { ), ), TextSpan( - text: "during app drawer search for a quick website visit or google search.", + text: + "during app drawer search for a quick website visit or google search.", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -181,9 +269,9 @@ showHintDialog(context) { children: [ TextSpan( text: - "- Tap on clock or swipe down on empty space to expand status bar.", + "- Tap on clock or swipe down on empty space to expand status bar.", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -197,10 +285,9 @@ showHintDialog(context) { text: TextSpan( children: [ TextSpan( - text: - "- Long press on clock to show/hide system UI.", + text: "- Long press on clock to show/hide system UI.", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -216,7 +303,7 @@ showHintDialog(context) { TextSpan( text: "- Long press", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -229,7 +316,7 @@ showHintDialog(context) { child: Icon( RemixIcon.apps_2, size: 24, - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, ), ), const WidgetSpan( @@ -237,11 +324,27 @@ showHintDialog(context) { width: 8, ), ), + TextSpan( + text: "to change drawer layout.", + style: TextStyle( + color: ShelfTheme.of(context).colors.onSecondary, + fontSize: 20, + fontWeight: FontWeight.w500), + ), + ], + ), + ), + const SizedBox( + height: 12, + ), + RichText( + text: TextSpan( + children: [ TextSpan( text: - "to change drawer layout.", + "- DoubleTap on empty space to show/hide bottom dashboard.", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -256,9 +359,9 @@ showHintDialog(context) { children: [ TextSpan( text: - "- DoubleTap on empty space to show/hide bottom dashboard.", + "- Long press on empty space for a surprise... or confetti... or perhaps, rain... whatever.", style: TextStyle( - color: ShelfTheme.of(context).colors.onTertiary, + color: ShelfTheme.of(context).colors.onSecondary, fontSize: 20, fontWeight: FontWeight.w500), ), @@ -270,4 +373,4 @@ showHintDialog(context) { ), ); }); -} \ No newline at end of file +} diff --git a/lib/utilities/user_prefs.dart b/lib/utilities/user_prefs.dart index 264d341..8ceaeb8 100644 --- a/lib/utilities/user_prefs.dart +++ b/lib/utilities/user_prefs.dart @@ -1,12 +1,17 @@ import 'package:shared_preferences/shared_preferences.dart'; -class PrefKeys{ - static String flowVisible = "flowVisible"; - static String systemUiVisible = "systemUiVisible"; - static String dashboardVisible = "dashboardVisible"; - static String greetingText = "greetingText"; - static String quickNoteText = "quickNoteText"; - static String drawerLayout = "drawerLayout"; +class PrefKeys { + static const String flowVisible = "flowVisible"; + static const String systemUiVisible = "systemUiVisible"; + static const String dashboardVisible = "dashboardVisible"; + static const String greetingText = "greetingText"; + static const String quickNoteText = "quickNoteText"; + static const String drawerLayout = "drawerLayout"; + static const String parallaxStatus = "parallaxStatus"; + // Custom Functions + static const String customWidget = "customWidget"; + static const String customPackage = "customPackage"; + static const String customBehaviour = "customBehaviour"; } -late SharedPreferences userPrefs; \ No newline at end of file +late SharedPreferences userPrefs; diff --git a/pubspec.lock b/pubspec.lock index 9db6de6..517ecc1 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -184,6 +184,14 @@ packages: url: "https://pub.dev" source: hosted version: "1.1.4" + parallax_rain: + dependency: "direct main" + description: + name: parallax_rain + sha256: "433eb7b572147f26da212d30959332bce87e55a270f725fb2e92e599e97b47d8" + url: "https://pub.dev" + source: hosted + version: "1.1.1" path: dependency: transitive description: diff --git a/pubspec.yaml b/pubspec.yaml index 3b18620..c090489 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -16,7 +16,7 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev # https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html # In Windows, build-name is used as the major, minor, and patch parts # of the product and file versions while build-number is used as the build suffix. -version: 1.0.0+1 +version: 1.0.2+3 environment: sdk: '>=3.4.0 <4.0.0' @@ -44,6 +44,7 @@ dependencies: flutter_staggered_grid_view: ^0.7.0 url_launcher: ^6.3.0 shared_preferences: ^2.2.3 + parallax_rain: ^1.1.1 dev_dependencies: flutter_test: