diff --git a/Cargo.lock b/Cargo.lock index 063f626..c2b50d7 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -303,6 +303,7 @@ dependencies = [ "syntect", "tui-logger", "tui-tree-widget", + "uuid", ] [[package]] diff --git a/Cargo.toml b/Cargo.toml index c9b44f5..fe5a0fc 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -17,6 +17,7 @@ tui-tree-widget = "0.24.0" tui-logger = "0.18.1" edtui = "0.11.1" strum = "0.27.2" +uuid = { version = "1.19.0", features = ["v4"] } [build-dependencies] # The link_qt_object_files feature is required for statically linking Qt 6. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /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 +. \ No newline at end of file diff --git a/README.md b/README.md index dc4dbd7..8a2fff5 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,8 @@ cd clide cargo install --path . ``` -After installation `clide` can be used directly +After installation `clide` can be used directly. +A path can optionally be provided to open a specific directory with `clide /path/to/project`. ```bash clide --help diff --git a/qml/ClideAboutWindow.qml b/qml/ClideAboutWindow.qml index 2922764..1b7c8a8 100644 --- a/qml/ClideAboutWindow.qml +++ b/qml/ClideAboutWindow.qml @@ -58,7 +58,7 @@ ApplicationWindow { + "

Project notes knoats.com

" + "

This project is developed at git.shaunreed.com

" + "

KDAB CXX-Qt repository

" - + "

Copyright (C) 2025 Shaun Reed, all rights reserved.

") + + "

Copyright (C) 2026 Shaun Reed, all rights reserved.

") color: RustColors.editor_text wrapMode: Text.WordWrap readOnly: true diff --git a/qml/ClideEditor.qml b/qml/ClideEditor.qml index b16d9b5..512b470 100644 --- a/qml/ClideEditor.qml +++ b/qml/ClideEditor.qml @@ -13,7 +13,7 @@ SplitView { // The path to the file to show in the text editor. // This is updated by a signal caught within ClideProjectView. // Initialized by the Default trait for the Rust QML singleton FileSystem. - required property string filePath; + required property string filePath // Customized handle to drag between the Editor and the Console. handle: Rectangle { diff --git a/qml/ClideProjectView.qml b/qml/ClideProjectView.qml index 1f97333..05d55ef 100644 --- a/qml/ClideProjectView.qml +++ b/qml/ClideProjectView.qml @@ -7,8 +7,8 @@ import clide.module 1.0 SplitView { id: root - // Path to the file selected in the tree view. - default property string selectedFilePath: FileSystem.filePath; + // Path to the directory of the project opened in clide. + required property string projectDir Layout.fillHeight: true Layout.fillWidth: true @@ -43,13 +43,18 @@ SplitView { anchors.fill: parent ClideTreeView { id: clideTreeView - onFileClicked: path => root.selectedFilePath = path + onFileClicked: path => root.projectDir = path + + // Path to the directory opened in the file explorer. + rootDirectory: root.projectDir } } } ClideEditor { SplitView.fillWidth: true - // Initialize using the Default trait in Rust QML singleton FileSystem. - filePath: root.selectedFilePath + + // Provide a path to the file currently open in the text editor. + // Initialized using the Default trait in Rust QML singleton FileSystem. + filePath: FileSystem.filePath } } diff --git a/qml/ClideTreeView.qml b/qml/ClideTreeView.qml index fa4b483..76ea446 100644 --- a/qml/ClideTreeView.qml +++ b/qml/ClideTreeView.qml @@ -8,13 +8,14 @@ Rectangle { id: root color: RustColors.explorer_background + required property string rootDirectory + signal fileClicked(string filePath) TreeView { id: fileSystemTreeView anchors.margins: 15 - // rootIndex: FileSystem.rootIndex property int lastIndex: -1 model: FileSystem @@ -24,8 +25,8 @@ Rectangle { clip: true Component.onCompleted: { - FileSystem.setDirectory(FileSystem.filePath) - fileSystemTreeView.expandRecursively(0, 4) + FileSystem.setDirectory(root.rootDirectory) + fileSystemTreeView.expandRecursively(0, -1) } // The delegate represents a single entry in the filesystem. @@ -42,9 +43,7 @@ Rectangle { indicator: Image { id: directoryIcon - x: treeDelegate.leftMargin + (treeDelegate.depth * treeDelegate.indentation) - anchors.verticalCenter: parent.verticalCenter - source: { + function setSourceImage() { let folderOpen = "data:image/svg+xml;utf8,"; let folderClosed = "data:image/svg+xml;utf8,"; let file = "data:image/svg+xml;utf8,"; @@ -56,6 +55,10 @@ Rectangle { return file } } + + x: treeDelegate.leftMargin + (treeDelegate.depth * treeDelegate.indentation) + anchors.verticalCenter: parent.verticalCenter + source: setSourceImage() sourceSize.width: 15 sourceSize.height: 15 fillMode: Image.PreserveAspectFit diff --git a/qml/main.qml b/qml/main.qml index cba1e07..fdbbf11 100644 --- a/qml/main.qml +++ b/qml/main.qml @@ -13,6 +13,8 @@ ApplicationWindow { visible: true width: 1200 + required property string appContextPath + menuBar: ClideMenuBar { } @@ -27,6 +29,7 @@ ApplicationWindow { title: qsTr("Error") } ClideProjectView { + projectDir: appWindow.appContextPath } } diff --git a/resources/tui.png b/resources/tui.png index 639cf3d..6de8fc1 100644 Binary files a/resources/tui.png and b/resources/tui.png differ diff --git a/src/gui.rs b/src/gui.rs index 6aefef4..add9993 100644 --- a/src/gui.rs +++ b/src/gui.rs @@ -1,18 +1,25 @@ +use crate::AppContext; use anyhow::Result; -use cxx_qt_lib::QString; +use cxx_qt_lib::{QMapPair, QMapPair_QString_QVariant, QString, QVariant}; use log::trace; pub mod colors; pub mod filesystem; -pub fn run(root_path: std::path::PathBuf) -> Result<()> { - trace!(target:"gui::run()", "Starting the GUI editor at {root_path:?}"); +pub fn run(app_context: AppContext) -> Result<()> { + trace!(target:"gui::run()", "Starting the GUI editor at {:?}", app_context.path); use cxx_qt_lib::{QGuiApplication, QQmlApplicationEngine, QUrl}; let mut app = QGuiApplication::new(); let mut engine = QQmlApplicationEngine::new(); + // Set QML property for the directory provided to the CLI. + let path = QString::from(app_context.path.to_string_lossy().to_string()); + let mut map = QMapPair_QString_QVariant::default(); + map.insert(QString::from("appContextPath"), QVariant::from(&path)); + engine.as_mut().unwrap().set_initial_properties(&map); + if let Some(engine) = engine.as_mut() { engine.add_import_path(&QString::from("qml/")); } diff --git a/src/main.rs b/src/main.rs index f5cf2eb..917b90b 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,5 +1,4 @@ -use crate::tui::Tui; -use anyhow::{Context, Result}; +use anyhow::{Context, Result, anyhow}; use clap::Parser; use log::{info, trace}; use std::process::{Command, Stdio}; @@ -25,41 +24,67 @@ struct Cli { pub gui: bool, } -fn main() -> Result<()> { - let args = Cli::parse(); - - let root_path = match args.path { - // If the CLI was provided a directory, convert it to absolute. - Some(path) => std::path::absolute(path)?, - // If no path was provided, use the current directory. - None => std::env::current_dir().unwrap_or( - // If we can't find the CWD, attempt to open the home directory. - dirs::home_dir().context("Failed to obtain home directory")?, - ), - }; - info!(target:"main()", "Root path detected: {root_path:?}"); - - match args.gui { - true => { - trace!(target:"main()", "Starting GUI"); - gui::run(root_path) +impl Cli { + fn run_mode(&self) -> Result { + let mut modes = Vec::new(); + self.tui.then(|| modes.push(RunMode::Tui)); + self.gui.then(|| modes.push(RunMode::GuiAttached)); + match &modes[..] { + [] => Ok(RunMode::Gui), + [mode] => Ok(*mode), + multiple => Err(anyhow!( + "More than one run mode found {multiple:?} please select one." + )), + } + } +} + +pub struct AppContext { + pub path: std::path::PathBuf, + pub run_mode: RunMode, +} + +impl AppContext { + fn new(cli: Cli) -> Result { + let path = match &cli.path { + // If the CLI was provided a directory, convert it to absolute. + Some(path) => std::path::absolute(path)?, + // If no path was provided, use the current directory. + None => std::env::current_dir().context("Failed to obtain current directory")?, + }; + info!(target:"main()", "Root path detected: {path:?}"); + + Ok(Self { + path, + run_mode: cli.run_mode()?, + }) + } +} + +#[derive(Copy, Clone, Debug, Default)] +pub enum RunMode { + #[default] + Gui, + GuiAttached, + Tui, +} + +fn main() -> Result<()> { + let args = Cli::parse(); + let app_context = AppContext::new(args)?; + match app_context.run_mode { + RunMode::GuiAttached => gui::run(app_context), + RunMode::Tui => tui::run(app_context), + RunMode::Gui => { + trace!(target:"main()", "Starting GUI in a new process"); + Command::new(std::env::current_exe()?) + .args(&["--gui", app_context.path.to_str().unwrap()]) + .stdout(Stdio::null()) + .stderr(Stdio::null()) + .stdin(Stdio::null()) + .spawn() + .context("Failed to start GUI") + .map(|_| ()) } - false => match args.tui { - // Open the TUI editor if requested, otherwise use the QML GUI by default. - true => { - trace!(target:"main()", "Starting TUI"); - Ok(Tui::new(root_path)?.start()?) - } - false => { - trace!(target:"main()", "Starting GUI in a new process"); - Command::new(std::env::current_exe()?) - .args(&["--gui", root_path.to_str().unwrap()]) - .stdout(Stdio::null()) - .stderr(Stdio::null()) - .stdin(Stdio::null()) - .spawn()?; - Ok(()) - } - }, } } diff --git a/src/tui.rs b/src/tui.rs index 3a0127d..d0569c5 100644 --- a/src/tui.rs +++ b/src/tui.rs @@ -7,6 +7,7 @@ mod explorer; mod logger; mod menu_bar; +use crate::AppContext; use anyhow::{Context, Result}; use log::{LevelFilter, debug, info, trace}; use ratatui::Terminal; @@ -23,21 +24,24 @@ use tui_logger::{ TuiLoggerFile, TuiLoggerLevelOutput, init_logger, set_default_level, set_log_file, }; -pub struct Tui { +struct Tui { terminal: Terminal>, root_path: std::path::PathBuf, } -impl Tui { - pub fn id() -> &'static str { - "Tui" - } +pub fn run(app_context: AppContext) -> Result<()> { + trace!(target:Tui::ID, "Starting TUI"); + Tui::new(app_context)?.start() +} - pub fn new(root_path: std::path::PathBuf) -> Result { - trace!(target:Self::id(), "Building {}", Self::id()); +impl Tui { + pub const ID: &str = "Tui"; + + fn new(app_context: AppContext) -> Result { + trace!(target:Self::ID, "Building {}", Self::ID); init_logger(LevelFilter::Trace)?; set_default_level(LevelFilter::Trace); - debug!(target:Self::id(), "Logging initialized"); + debug!(target:Self::ID, "Logging initialized"); let mut dir = env::temp_dir(); dir.push("clide.log"); @@ -49,16 +53,16 @@ impl Tui { .output_file(false) .output_separator(':'); set_log_file(file_options); - debug!(target:Self::id(), "Logging to file: {dir:?}"); + debug!(target:Self::ID, "Logging to file: {dir:?}"); Ok(Self { terminal: Terminal::new(CrosstermBackend::new(stdout()))?, - root_path, + root_path: app_context.path, }) } - pub fn start(self) -> Result<()> { - info!(target:Self::id(), "Starting the TUI editor at {:?}", self.root_path); + fn start(self) -> Result<()> { + info!(target:Self::ID, "Starting the TUI editor at {:?}", self.root_path); ratatui::crossterm::execute!( stdout(), EnterAlternateScreen, @@ -75,7 +79,7 @@ impl Tui { } fn stop() -> Result<()> { - info!(target:Self::id(), "Stopping the TUI editor"); + info!(target:Self::ID, "Stopping the TUI editor"); disable_raw_mode()?; ratatui::crossterm::execute!( stdout(), diff --git a/src/tui/about.rs b/src/tui/about.rs index c5f222a..aa68961 100644 --- a/src/tui/about.rs +++ b/src/tui/about.rs @@ -1,6 +1,5 @@ use ratatui::buffer::Buffer; use ratatui::layout::{Constraint, Direction, Layout, Rect}; -use ratatui::style::{Modifier, Style}; use ratatui::text::{Line, Span}; use ratatui::widgets::{Block, Borders, Clear, Padding, Paragraph, Widget, Wrap}; @@ -8,9 +7,7 @@ pub struct About {} impl About { #[allow(unused)] - pub fn id() -> &'static str { - "About" - } + pub const ID: &str = "About"; pub fn new() -> Self { // trace!(target:Self::id(), "Building {}", Self::id()); @@ -23,54 +20,61 @@ impl Widget for About { where Self: Sized, { - Clear::default().render(area, buf); - // Split main area let chunks = Layout::default() .direction(Direction::Vertical) .constraints([ - Constraint::Fill(2), // image column - Constraint::Fill(1), // image column - Constraint::Fill(2), // text column + Constraint::Fill(1), // Image Layout + Constraint::Fill(2), // Description ]) .split(area); - - let top_chunks = Layout::default() - .direction(Direction::Horizontal) - .constraints([ - Constraint::Fill(1), - Constraint::Fill(3), - Constraint::Fill(1), - ]) - .split(chunks[1]); - - let bottom_chunks = Layout::default() - .direction(Direction::Horizontal) - .constraints([ - Constraint::Fill(1), - Constraint::Fill(3), - Constraint::Fill(1), - ]) - .split(chunks[2]); - - // ---------- IMAGE ---------- - let kilroy_art = [ - " * ", - " |.===. ", - " {}o o{} ", - "-----------------------ooO--(_)--Ooo---------------------------", - "# #", - "# CLIDE WAS HERE #", - "# #", - "# https://git.shaunreed.com/shaunred/clide #", - "# https://shaunreed.com/shaunred/clide #", - "# #", + let kilroy = [ + " * ", + " |.===. ", + " {}o o{} ", + "-ooO--(_)--Ooo", + "CLIDE WAS HERE", ]; + let kilroy_rect = Rect { + x: chunks[1].x, + y: chunks[1].y - kilroy.len() as u16 + 2, + width: area.width, + height: kilroy.len() as u16, + }; + // info!(target: About::ID, "Created rect: {kilroy_rect:?}"); - let kilroy_lines: Vec = kilroy_art + let kilroy_lines: Vec = kilroy.iter().map(|l| Line::from(Span::raw(*l))).collect(); + let about_text = [ + "Clide", + "", + "Author: Shaun Reed", + "Email: shaunrd0@gmail.com", + "URL: https://git.shaunreed.com/shaunrd0/clide", + "Blog: https://shaunreed.com", + "", + "Description:", + concat!( + "CLIDE is an extendable command-line driven development environment written in Rust", + " using the Qt UI framework that supports both full and headless Linux environments.", + " The GUI is written in QML compiled through Rust using the cxx-qt crate, while the", + " TUI was implemented using the ratatui crate.", + ), + ]; + let about_lines: Vec = about_text .iter() .map(|l| Line::from(Span::raw(*l))) .collect(); + Clear::default().render(kilroy_rect, buf); + Clear::default().render(chunks[1], buf); + Paragraph::new(about_lines) + .block( + Block::default() + .title("About") + .borders(Borders::ALL) + .padding(Padding::top(0)), + ) + .wrap(Wrap { trim: false }) + .render(chunks[1], buf); Paragraph::new(kilroy_lines) .block( Block::default() @@ -79,60 +83,6 @@ impl Widget for About { ) .wrap(Wrap { trim: false }) .centered() - .render(top_chunks[1], buf); - - // ---------- TEXT ---------- - let about_text = vec![ - Line::from(vec![Span::styled( - "clide\n", - Style::default().add_modifier(Modifier::BOLD), - )]) - .centered(), - Line::from(""), - Line::from(vec![ - Span::styled("Author: ", Style::default().add_modifier(Modifier::BOLD)), - Span::raw("Shaun Reed"), - ]) - .left_aligned(), - Line::from(vec![ - Span::styled("Email: ", Style::default().add_modifier(Modifier::BOLD)), - Span::raw("shaunrd0@gmail.com"), - ]) - .left_aligned(), - Line::from(vec![ - Span::styled("URL: ", Style::default().add_modifier(Modifier::BOLD)), - Span::raw("https://git.shaunreed.com/shaunrd0/clide"), - ]) - .left_aligned(), - Line::from(vec![ - Span::styled("Blog: ", Style::default().add_modifier(Modifier::BOLD)), - Span::raw("https://shaunreed.com"), - ]) - .left_aligned(), - Line::from(""), - Line::from(vec![Span::styled( - "Description\n", - Style::default().add_modifier(Modifier::BOLD), - )]) - .left_aligned(), - Line::from(concat!( - "CLIDE is an extendable command-line driven development environment written in Rust using the Qt UI framework that supports both full and headless Linux environments. ", - "The GUI is written in QML compiled through Rust using the cxx-qt crate, while the TUI was implemented using the ratatui crate. ", - )) - .style(Style::default()) - .left_aligned(), - ]; - Block::bordered().render(area, buf); - - let paragraph = Paragraph::new(about_text) - .block( - Block::default() - .title("About") - .borders(Borders::ALL) - .padding(Padding::top(0)), - ) - .wrap(Wrap { trim: true }); - - paragraph.render(bottom_chunks[1], buf); + .render(kilroy_rect, buf); } } diff --git a/src/tui/app.rs b/src/tui/app.rs index 6537437..d925d2c 100644 --- a/src/tui/app.rs +++ b/src/tui/app.rs @@ -17,7 +17,7 @@ use ratatui::crossterm::event::{ use ratatui::layout::{Constraint, Direction, Layout, Rect}; use ratatui::prelude::{Color, Widget}; use ratatui::widgets::{Paragraph, Wrap}; -use std::path::PathBuf; +use std::path::{Path, PathBuf}; use std::time::Duration; #[derive(Debug, Clone, Copy, PartialEq)] @@ -29,7 +29,7 @@ pub enum AppComponent { } pub struct App<'a> { - editor_tabs: EditorTab, + editor_tab: EditorTab, explorer: Explorer<'a>, logger: Logger, menu_bar: MenuBar, @@ -38,14 +38,12 @@ pub struct App<'a> { } impl<'a> App<'a> { - pub fn id() -> &'static str { - "App" - } + pub const ID: &'static str = "App"; pub fn new(root_path: PathBuf) -> Result { - trace!(target:Self::id(), "Building {}", Self::id()); + trace!(target:Self::ID, "Building {}", Self::ID); let app = Self { - editor_tabs: EditorTab::new(None), + editor_tab: EditorTab::new(), explorer: Explorer::new(&root_path)?, logger: Logger::new(), menu_bar: MenuBar::new(), @@ -57,13 +55,13 @@ impl<'a> App<'a> { /// Logic that should be executed once on application startup. pub fn start(&mut self) -> Result<()> { - trace!(target:Self::id(), "Starting App"); + trace!(target:Self::ID, "Starting App"); Ok(()) } pub fn run(mut self, mut terminal: DefaultTerminal) -> Result<()> { self.start()?; - trace!(target:Self::id(), "Entering App run loop"); + trace!(target:Self::ID, "Entering App run loop"); loop { terminal.draw(|f| { f.render_widget(&mut self, f.area()); @@ -85,11 +83,11 @@ impl<'a> App<'a> { fn draw_bottom_status(&self, area: Rect, buf: &mut Buffer) { // Determine help text from the most recently focused component. let help = match self.last_active { - AppEditor => match self.editor_tabs.current_editor() { + AppEditor => match self.editor_tab.current_editor() { Some(editor) => editor.component_state.help_text.clone(), None => { - if !self.editor_tabs.is_empty() { - error!(target:Self::id(), "Failed to get Editor while drawing bottom status bar"); + if !self.editor_tab.is_empty() { + error!(target:Self::ID, "Failed to get Editor while drawing bottom status bar"); } "Failed to get current Editor while getting widget help text".to_string() } @@ -113,26 +111,26 @@ impl<'a> App<'a> { } fn clear_focus(&mut self) { - info!(target:Self::id(), "Clearing all widget focus"); + info!(target:Self::ID, "Clearing all widget focus"); self.explorer.component_state.set_focus(Focus::Inactive); self.explorer.component_state.set_focus(Focus::Inactive); self.logger.component_state.set_focus(Focus::Inactive); self.menu_bar.component_state.set_focus(Focus::Inactive); - match self.editor_tabs.current_editor_mut() { + match self.editor_tab.current_editor_mut() { None => { - error!(target:Self::id(), "Failed to get current Editor while clearing focus") + error!(target:Self::ID, "Failed to get current Editor while clearing focus") } Some(editor) => editor.component_state.set_focus(Focus::Inactive), } } fn change_focus(&mut self, focus: AppComponent) { - info!(target:Self::id(), "Changing widget focus to {:?}", focus); + info!(target:Self::ID, "Changing widget focus to {:?}", focus); self.clear_focus(); match focus { - AppEditor => match self.editor_tabs.current_editor_mut() { + AppEditor => match self.editor_tab.current_editor_mut() { None => { - error!(target:Self::id(), "Failed to get current Editor while changing focus") + error!(target:Self::ID, "Failed to get current Editor while changing focus") } Some(editor) => editor.component_state.set_focus(Focus::Active), }, @@ -142,32 +140,6 @@ impl<'a> App<'a> { } self.last_active = focus; } - - /// Refresh the contents of the editor to match the selected TreeItem in the file Explorer. - /// If the selected item is not a file, this does nothing. - #[allow(unused)] - fn refresh_editor_contents(&mut self) -> Result<()> { - // TODO: This may be useful for a preview mode of the selected file prior to opening a tab. - // Use the currently selected TreeItem or get an absolute path to this source file. - // let selected_pathbuf = match self.explorer.selected() { - // Ok(path) => PathBuf::from(path), - // Err(_) => PathBuf::from(std::path::absolute(file!())?.to_string_lossy().to_string()), - // }; - // match self.editor_tabs.current_editor_mut() { - // None => bail!("Failed to get current Editor while refreshing editor contents"), - // Some(editor) => { - // let current_file_path = editor - // .file_path - // .clone() - // .context("Failed to get Editor current file_path")?; - // if selected_pathbuf == current_file_path || !selected_pathbuf.is_file() { - // return Ok(()); - // } - // editor.set_contents(&selected_pathbuf) - // } - // } - Ok(()) - } } impl<'a> Widget for &mut App<'a> { @@ -225,7 +197,7 @@ impl<'a> Widget for &mut App<'a> { Constraint::Fill(1), // Editor contents. ]) .split(horizontal[1]); - self.editor_tabs + self.editor_tab .render(editor_layout[0], editor_layout[1], buf); self.explorer.render(horizontal[0], buf); } @@ -237,7 +209,7 @@ impl<'a> Widget for &mut App<'a> { Constraint::Fill(1), // Editor contents. ]) .split(horizontal[0]); - self.editor_tabs + self.editor_tab .render(editor_layout[0], editor_layout[1], buf); } } @@ -258,7 +230,7 @@ impl<'a> Widget for &mut App<'a> { } if self.about { - let about_area = area.centered(Constraint::Percentage(50), Constraint::Percentage(45)); + let about_area = area.centered(Constraint::Percentage(40), Constraint::Percentage(50)); About::new().render(about_area, buf); } } @@ -279,7 +251,7 @@ impl<'a> Component for App<'a> { } // Handle events for all components. let action = match self.last_active { - AppEditor => self.editor_tabs.handle_event(event.clone())?, + AppEditor => self.editor_tab.handle_event(event.clone())?, AppExplorer => self.explorer.handle_event(event.clone())?, AppLogger => self.logger.handle_event(event.clone())?, AppMenuBar => self.menu_bar.handle_event(event.clone())?, @@ -288,7 +260,7 @@ impl<'a> Component for App<'a> { // Components should always handle mouse events for click interaction. if let Some(mouse) = event.as_mouse_event() { if mouse.kind == MouseEventKind::Down(MouseButton::Left) { - if let Some(editor) = self.editor_tabs.current_editor_mut() { + if let Some(editor) = self.editor_tab.current_editor_mut() { editor.handle_mouse_events(mouse)?; } self.explorer.handle_mouse_events(mouse)?; @@ -299,50 +271,50 @@ impl<'a> Component for App<'a> { // Handle actions returned from widgets that may need context on other widgets or app state. match action { Action::Quit | Action::Handled => Ok(action), - Action::Save => match self.editor_tabs.current_editor_mut() { + Action::Save => match self.editor_tab.current_editor_mut() { None => { - error!(target:Self::id(), "Failed to get current editor while handling App Action::Save"); + error!(target:Self::ID, "Failed to get current editor while handling App Action::Save"); Ok(Action::Noop) } Some(editor) => match editor.save() { Ok(_) => Ok(Action::Handled), Err(e) => { - error!(target:Self::id(), "Failed to save editor contents: {e}"); + error!(target:Self::ID, "Failed to save editor contents: {e}"); Ok(Action::Noop) } }, }, Action::OpenTab => { if let Ok(path) = self.explorer.selected() { - let path_buf = PathBuf::from(path); - self.editor_tabs.open_tab(&path_buf)?; + let path_buf = Path::new(&path); + self.editor_tab.open_tab(path_buf)?; Ok(Action::Handled) } else { Ok(Action::Noop) } } - Action::CloseTab => match self.editor_tabs.close_current_tab() { + Action::CloseTab => match self.editor_tab.close_current_tab() { Ok(_) => Ok(Action::Handled), Err(_) => Ok(Action::Noop), }, Action::ReloadFile => { - trace!(target:Self::id(), "Reloading file for current editor"); - if let Some(editor) = self.editor_tabs.current_editor_mut() { + trace!(target:Self::ID, "Reloading file for current editor"); + if let Some(editor) = self.editor_tab.current_editor_mut() { editor .reload_contents() .map(|_| Action::Handled) .context("Failed to handle Action::ReloadFile") } else { - error!(target:Self::id(), "Failed to get current editor while handling App Action::ReloadFile"); + error!(target:Self::ID, "Failed to get current editor while handling App Action::ReloadFile"); Ok(Action::Noop) } } Action::ShowHideLogger => { - self.logger.component_state.togget_visible(); + self.logger.component_state.toggle_visible(); Ok(Action::Handled) } Action::ShowHideExplorer => { - self.explorer.component_state.togget_visible(); + self.explorer.component_state.toggle_visible(); Ok(Action::Handled) } Action::ShowHideAbout => { diff --git a/src/tui/component.rs b/src/tui/component.rs index 5a119fe..2b73ae2 100644 --- a/src/tui/component.rs +++ b/src/tui/component.rs @@ -111,7 +111,7 @@ impl FocusState for ComponentState { fn with_focus(self, focus: Focus) -> Self { Self { focus, - vis: Visibility::Visible, + vis: self.vis, help_text: self.help_text, } } @@ -142,7 +142,7 @@ pub enum Visibility { pub trait VisibleState { fn with_visible(self, vis: Visibility) -> Self; fn set_visible(&mut self, vis: Visibility); - fn togget_visible(&mut self); + fn toggle_visible(&mut self); } impl VisibleState for ComponentState { @@ -158,7 +158,7 @@ impl VisibleState for ComponentState { self.vis = vis; } - fn togget_visible(&mut self) { + fn toggle_visible(&mut self) { match self.vis { Visibility::Visible => self.set_visible(Visibility::Hidden), Visibility::Hidden => self.set_visible(Visibility::Visible), diff --git a/src/tui/editor.rs b/src/tui/editor.rs index 5070d90..a1f0081 100644 --- a/src/tui/editor.rs +++ b/src/tui/editor.rs @@ -9,6 +9,7 @@ use ratatui::crossterm::event::{Event, KeyCode, KeyEvent, KeyModifiers}; use ratatui::layout::{Alignment, Rect}; use ratatui::prelude::{Color, Style}; use ratatui::widgets::{Block, Borders, Padding, Widget}; +use std::path::PathBuf; use syntect::parsing::SyntaxSet; pub struct Editor { @@ -20,12 +21,10 @@ pub struct Editor { } impl Editor { - pub fn id() -> &'static str { - "Editor" - } + pub const ID: &str = "Editor"; - pub fn new(path: &std::path::PathBuf) -> Self { - trace!(target:Self::id(), "Building {}", Self::id()); + pub fn new(path: &std::path::Path) -> Self { + trace!(target:Self::ID, "Building {}", Self::ID); Editor { state: EditorState::default(), event_handler: EditorEventHandler::default(), @@ -39,24 +38,24 @@ impl Editor { } pub fn reload_contents(&mut self) -> Result<()> { - trace!(target:Self::id(), "Reloading editor file contents {:?}", self.file_path); + trace!(target:Self::ID, "Reloading editor file contents {:?}", self.file_path); match self.file_path.clone() { None => { - error!(target:Self::id(), "Failed to reload editor contents with None file_path"); + error!(target:Self::ID, "Failed to reload editor contents with None file_path"); bail!("Failed to reload editor contents with None file_path") } Some(path) => self.set_contents(&path), } } - pub fn set_contents(&mut self, path: &std::path::PathBuf) -> Result<()> { - trace!(target:Self::id(), "Setting Editor contents from path {:?}", path); + pub fn set_contents(&mut self, path: &std::path::Path) -> Result<()> { + trace!(target:Self::ID, "Setting Editor contents from path {:?}", path); if let Ok(contents) = std::fs::read_to_string(path) { let lines: Vec<_> = contents .lines() .map(|line| line.chars().collect::>()) .collect(); - self.file_path = Some(path.clone()); + self.file_path = Some(PathBuf::from(path)); self.state.lines = Lines::new(lines); self.state.cursor.row = 0; self.state.cursor.col = 0; @@ -66,10 +65,10 @@ impl Editor { pub fn save(&self) -> Result<()> { if let Some(path) = &self.file_path { - trace!(target:Self::id(), "Saving Editor contents {:?}", path); + trace!(target:Self::ID, "Saving Editor contents {:?}", path); return std::fs::write(path, self.state.lines.to_string()).map_err(|e| e.into()); }; - error!(target:Self::id(), "Failed saving Editor contents; file_path was None"); + error!(target:Self::ID, "Failed saving Editor contents; file_path was None"); bail!("File not saved. No file path set.") } } @@ -86,7 +85,7 @@ impl Widget for &mut Editor { .syntax_set .find_syntax_by_extension(lang) .map(|s| s.name.to_string()) - .unwrap_or("Unknown".to_string()); + .unwrap_or_else(|| String::from("Unknown")); EditorView::new(&mut self.state) .wrap(true) diff --git a/src/tui/editor_tab.rs b/src/tui/editor_tab.rs index 1a5fb01..76c2de4 100644 --- a/src/tui/editor_tab.rs +++ b/src/tui/editor_tab.rs @@ -19,35 +19,20 @@ pub struct EditorTab { } impl EditorTab { - fn id() -> &'static str { - "EditorTab" - } + pub const ID: &str = "EditorTab"; - pub fn new(path: Option<&std::path::PathBuf>) -> Self { - trace!(target:Self::id(), "Building EditorTab with path {path:?}"); - match path { - None => Self { - editors: HashMap::new(), - tab_order: Vec::new(), - current_editor: 0, - }, - Some(path) => { - let tab_order = vec![path.to_string_lossy().to_string()]; - Self { - editors: HashMap::from([( - tab_order.first().unwrap().to_owned(), - Editor::new(path), - )]), - tab_order, - current_editor: 0, - } - } + pub fn new() -> Self { + trace!(target:Self::ID, "Building {}", Self::ID); + Self { + editors: HashMap::new(), + tab_order: Vec::new(), + current_editor: 0, } } pub fn next_editor(&mut self) { let next = (self.current_editor + 1) % self.tab_order.len(); - trace!(target:Self::id(), "Moving from {} to next editor tab at {}", self.current_editor, next); + trace!(target:Self::ID, "Moving from {} to next editor tab at {}", self.current_editor, next); self.set_tab_focus(Focus::Active, next); self.current_editor = next; } @@ -57,7 +42,7 @@ impl EditorTab { .current_editor .checked_sub(1) .unwrap_or(self.tab_order.len() - 1); - trace!(target:Self::id(), "Moving from {} to previous editor tab at {}", self.current_editor, prev); + trace!(target:Self::ID, "Moving from {} to previous editor tab at {}", self.current_editor, prev); self.set_tab_focus(Focus::Active, prev); self.current_editor = prev; } @@ -66,7 +51,7 @@ impl EditorTab { match self.tab_order.get(index) { None => { if !self.tab_order.is_empty() { - error!(target:Self::id(), "Failed to get editor tab key with invalid index {index}"); + error!(target:Self::ID, "Failed to get editor tab key with invalid index {index}"); } None } @@ -84,16 +69,16 @@ impl EditorTab { } pub fn set_current_tab_focus(&mut self, focus: Focus) { - trace!(target:Self::id(), "Setting current tab {} focus to {:?}", self.current_editor, focus); + trace!(target:Self::ID, "Setting current tab {} focus to {:?}", self.current_editor, focus); self.set_tab_focus(focus, self.current_editor) } pub fn set_tab_focus(&mut self, focus: Focus, index: usize) { - trace!(target:Self::id(), "Setting tab {} focus to {:?}", index, focus); + trace!(target:Self::ID, "Setting tab {} focus to {:?}", index, focus); if focus == Focus::Active && index != self.current_editor { // If we are setting another tab to active, disable the current one. trace!( - target:Self::id(), + target:Self::ID, "New tab {} focus set to Active; Setting current tab {} to Inactive", index, self.current_editor @@ -102,12 +87,12 @@ impl EditorTab { } match self.get_editor_key(index) { None => { - error!(target:Self::id(), "Failed setting tab focus for invalid key {index}"); + error!(target:Self::ID, "Failed setting tab focus for invalid key {index}"); } Some(key) => match self.editors.get_mut(&key) { None => { error!( - target:Self::id(), + target:Self::ID, "Failed to update tab focus at index {} with invalid key: {}", self.current_editor, self.tab_order[self.current_editor] @@ -118,13 +103,13 @@ impl EditorTab { } } - pub fn open_tab(&mut self, path: &std::path::PathBuf) -> Result<()> { - trace!(target:Self::id(), "Opening new EditorTab with path {:?}", path); + pub fn open_tab(&mut self, path: &std::path::Path) -> Result<()> { + trace!(target:Self::ID, "Opening new EditorTab with path {:?}", path); if self .editors .contains_key(&path.to_string_lossy().to_string()) { - warn!(target:Self::id(), "EditorTab already opened with this file"); + warn!(target:Self::ID, "EditorTab already opened with this file"); return Ok(()); } @@ -145,18 +130,16 @@ impl EditorTab { let key = self .tab_order .get(index) - .ok_or(anyhow!( - "Failed to get tab order with invalid index {index}" - ))? + .ok_or_else(|| anyhow!("Failed to get tab order with invalid index {index}"))? .to_owned(); match self.editors.remove(&key) { None => { - error!(target:Self::id(), "Failed to remove editor tab {key} with invalid index {index}") + error!(target:Self::ID, "Failed to remove editor tab {key} with invalid index {index}") } Some(_) => { self.prev_editor(); self.tab_order.remove(index); - info!(target:Self::id(), "Closed editor tab {key} at index {index}") + info!(target:Self::ID, "Closed editor tab {key} at index {index}") } } Ok(()) @@ -170,10 +153,10 @@ impl EditorTab { // TODO: Only file name is displayed in tab title, so files with the same name in different // directories will appear confusing. let tab_titles = self.tab_order.iter().map(|t| { - std::path::PathBuf::from(t) + std::path::Path::new(t) .file_name() .map(|f| f.to_string_lossy().to_string()) - .unwrap_or("Unknown".to_string()) + .unwrap_or_else(|| String::from("Unknown")) }); // Don't set border color based on ComponentState::focus, the Editor renders the border. Tabs::new(tab_titles) diff --git a/src/tui/explorer.rs b/src/tui/explorer.rs index 14a5585..fbd2063 100644 --- a/src/tui/explorer.rs +++ b/src/tui/explorer.rs @@ -7,8 +7,9 @@ use ratatui::layout::{Alignment, Position, Rect}; use ratatui::prelude::Style; use ratatui::style::{Color, Modifier}; use ratatui::widgets::{Block, Borders, StatefulWidget, Widget}; +use std::ffi::OsStr; use std::fs; -use std::path::PathBuf; +use std::path::{Path, PathBuf}; use tui_tree_widget::{Tree, TreeItem, TreeState}; #[derive(Debug)] @@ -20,12 +21,10 @@ pub struct Explorer<'a> { } impl<'a> Explorer<'a> { - pub fn id() -> &'static str { - "Explorer" - } + pub const ID: &'static str = "Explorer"; pub fn new(path: &PathBuf) -> Result { - trace!(target:Self::id(), "Building {}", Self::id()); + trace!(target:Self::ID, "Building {}", Self::ID); let explorer = Explorer { root_path: path.to_owned(), tree_items: Self::build_tree_from_path(path.to_owned())?, @@ -40,23 +39,24 @@ impl<'a> Explorer<'a> { fn build_tree_from_path(path: PathBuf) -> Result> { let mut children = vec![]; - if let Ok(entries) = fs::read_dir(&path) { + let clean_path = fs::canonicalize(path)?; + if let Ok(entries) = fs::read_dir(&clean_path) { let mut paths = entries .map(|res| res.map(|e| e.path())) .collect::, std::io::Error>>() .context(format!( "Failed to build vector of paths under directory: {:?}", - path + clean_path ))?; paths.sort(); for path in paths { if path.is_dir() { children.push(Self::build_tree_from_path(path)?); } else { - if let Ok(path) = std::path::absolute(&path) { + if let Ok(path) = fs::canonicalize(&path) { let path_str = path.to_string_lossy().to_string(); children.push(TreeItem::new_leaf( - path_str, + path_str + uuid::Uuid::new_v4().to_string().as_str(), path.file_name() .context("Failed to get file name from path.")? .to_string_lossy() @@ -67,22 +67,16 @@ impl<'a> Explorer<'a> { } } - let abs = std::path::absolute(&path) - .context(format!( - "Failed to find absolute path for TreeItem: {:?}", - path - ))? - .to_string_lossy() - .to_string(); TreeItem::new( - abs, - path.file_name() - .expect("Failed to get file name from path.") + clean_path.to_string_lossy().to_string() + uuid::Uuid::new_v4().to_string().as_str(), + clean_path + .file_name() + .context(format!("Failed to get file name from path: {clean_path:?}"))? .to_string_lossy() .to_string(), children, ) - .context("Failed to build tree from path.") + .context(format!("Failed to build tree from path: {clean_path:?}")) } pub fn selected(&self) -> Result { @@ -99,7 +93,10 @@ impl<'a> Explorer<'a> { impl<'a> Widget for &mut Explorer<'a> { fn render(self, area: Rect, buf: &mut Buffer) { if let Ok(tree) = Tree::new(&self.tree_items.children()) { - let file_name = self.root_path.file_name().unwrap_or("Unknown".as_ref()); + let file_name = self + .root_path + .file_name() + .unwrap_or_else(|| OsStr::new("Unknown")); StatefulWidget::render( tree.block( Block::default() @@ -145,7 +142,7 @@ impl<'a> Component for Explorer<'a> { fn handle_key_events(&mut self, key: KeyEvent) -> Result { if key.code == KeyCode::Enter { if let Ok(selected) = self.selected() { - if PathBuf::from(&selected).is_file() { + if Path::new(&selected).is_file() { return Ok(Action::OpenTab); } } diff --git a/src/tui/logger.rs b/src/tui/logger.rs index a0d2403..c68e441 100644 --- a/src/tui/logger.rs +++ b/src/tui/logger.rs @@ -15,12 +15,10 @@ pub struct Logger { } impl Logger { - pub fn id() -> &'static str { - "Logger" - } + pub const ID: &str = "Logger"; pub fn new() -> Self { - trace!(target:Self::id(), "Building {}", Self::id()); + trace!(target:Self::ID, "Building {}", Self::ID); let state = TuiWidgetState::new(); state.transition(TuiWidgetEvent::HideKey); Self { diff --git a/src/tui/menu_bar.rs b/src/tui/menu_bar.rs index bc11bb0..1de6b76 100644 --- a/src/tui/menu_bar.rs +++ b/src/tui/menu_bar.rs @@ -2,6 +2,7 @@ use crate::tui::component::{Action, Component, ComponentState, FocusState}; use crate::tui::menu_bar::MenuBarItemOption::{ About, CloseTab, Exit, Reload, Save, ShowHideExplorer, ShowHideLogger, }; +use anyhow::Context; use log::trace; use ratatui::buffer::Buffer; use ratatui::crossterm::event::{KeyCode, KeyEvent}; @@ -83,13 +84,11 @@ pub struct MenuBar { } impl MenuBar { - pub fn id() -> &'static str { - "MenuBar" - } + pub const ID: &str = "MenuBar"; const DEFAULT_HELP: &str = "(←/h)/(→/l): Select option | Enter: Choose selection"; pub fn new() -> Self { - trace!(target:Self::id(), "Building {}", Self::id()); + trace!(target:Self::ID, "Building {}", Self::ID); Self { selected: MenuBarItem::File, opened: None, @@ -154,7 +153,7 @@ impl MenuBar { height, }; // TODO: X offset for item option? It's fine as-is, but it might look nicer. - // trace!(target:Self::id(), "Building Rect under MenuBar popup {}", rect); + // trace!(target:Self::ID, "Building Rect under MenuBar popup {}", rect); rect } } @@ -192,7 +191,11 @@ impl Component for MenuBar { } KeyCode::Enter => { if let Some(selected) = self.list_state.selected() { - let selection = self.selected.options()[selected]; + let selection = self + .selected + .options() + .get(selected) + .context("Failed to get selected MenuBar option")?; return match selection { Save => Ok(Action::Save), Exit => Ok(Action::Quit),