Compare commits
52 Commits
app-contex
...
4d81cd51a6
| Author | SHA1 | Date | |
|---|---|---|---|
| 4d81cd51a6 | |||
| 7149ad0118 | |||
| 1e635ee059 | |||
| 42a40fe7f3 | |||
| ce2949159c | |||
| 3ffdcc2865 | |||
| ecd94a2621 | |||
| 2713d29285 | |||
| d2846e1e4e | |||
| bccc5a35e2 | |||
| e65eb20048 | |||
| f10d4cd41d | |||
| 507a4d8651 | |||
| ce6c12f068 | |||
| fe6390c1cd | |||
| a8de77f370 | |||
| b35b98743b | |||
| 733a43ccde | |||
| b65565adfa | |||
| fac6ea6bcd | |||
| 7fe3e3e14d | |||
| cf59fdfcca | |||
| 6a4957588d | |||
| f4242f7749 | |||
| fd3c8fb204 | |||
| fd9d47f0c0 | |||
| d53ef9aa1b | |||
| a29ae43e84 | |||
| 41a9a2a3bf | |||
| 7bf6c3299c | |||
| 90c10d2a16 | |||
| 2dcf0529d1 | |||
| f740ff347b | |||
| 9b86553513 | |||
| 365940267f | |||
| b426b88b79 | |||
| bdf942371c | |||
| b62dce631f | |||
| 1546eb1028 | |||
| 4f3aebe64f | |||
| 413500dad3 | |||
| b0064c2f69 | |||
| 0f055603a2 | |||
| 094ac92fe4 | |||
| 3b8e407632 | |||
| d2f5823594 | |||
| be9981291c | |||
| 500a329dea | |||
| 70e9f79c8a | |||
| 13a405a801 | |||
| a6d2fb9e31 | |||
| 8b71af06a8 |
@@ -1,3 +0,0 @@
|
|||||||
|
|
||||||
[build]
|
|
||||||
rustflags = [ "-C", "link-arg=-fuse-ld=lld", ]
|
|
||||||
30
Cargo.lock
generated
30
Cargo.lock
generated
@@ -299,11 +299,9 @@ dependencies = [
|
|||||||
"edtui",
|
"edtui",
|
||||||
"log",
|
"log",
|
||||||
"ratatui",
|
"ratatui",
|
||||||
"strum",
|
|
||||||
"syntect",
|
"syntect",
|
||||||
"tui-logger",
|
"tui-logger",
|
||||||
"tui-tree-widget",
|
"tui-tree-widget",
|
||||||
"uuid",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@@ -453,9 +451,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cxx"
|
name = "cxx"
|
||||||
version = "1.0.194"
|
version = "1.0.192"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "747d8437319e3a2f43d93b341c137927ca70c0f5dabeea7a005a73665e247c7e"
|
checksum = "bbda285ba6e5866529faf76352bdf73801d9b44a6308d7cd58ca2379f378e994"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"cc",
|
"cc",
|
||||||
"cxx-build",
|
"cxx-build",
|
||||||
@@ -468,9 +466,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cxx-build"
|
name = "cxx-build"
|
||||||
version = "1.0.194"
|
version = "1.0.192"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "b0f4697d190a142477b16aef7da8a99bfdc41e7e8b1687583c0d23a79c7afc1e"
|
checksum = "af9efde466c5d532d57efd92f861da3bdb7f61e369128ce8b4c3fe0c9de4fa4d"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"cc",
|
"cc",
|
||||||
"codespan-reporting 0.13.1",
|
"codespan-reporting 0.13.1",
|
||||||
@@ -483,9 +481,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cxx-gen"
|
name = "cxx-gen"
|
||||||
version = "0.7.194"
|
version = "0.7.192"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "035b6c61a944483e8a4b2ad4fb8b13830d63491bd004943716ad16d85dcc64bc"
|
checksum = "ee08d1131e8f050a1d1acbb7c699e5c8d29c325dffc382331c280d99f98c2618"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"codespan-reporting 0.13.1",
|
"codespan-reporting 0.13.1",
|
||||||
"indexmap",
|
"indexmap",
|
||||||
@@ -566,9 +564,9 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cxxbridge-cmd"
|
name = "cxxbridge-cmd"
|
||||||
version = "1.0.194"
|
version = "1.0.192"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "d0956799fa8678d4c50eed028f2de1c0552ae183c76e976cf7ca8c4e36a7c328"
|
checksum = "3efb93799095bccd4f763ca07997dc39a69e5e61ab52d2c407d4988d21ce144d"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"clap",
|
"clap",
|
||||||
"codespan-reporting 0.13.1",
|
"codespan-reporting 0.13.1",
|
||||||
@@ -580,15 +578,15 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cxxbridge-flags"
|
name = "cxxbridge-flags"
|
||||||
version = "1.0.194"
|
version = "1.0.192"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "23384a836ab4f0ad98ace7e3955ad2de39de42378ab487dc28d3990392cb283a"
|
checksum = "3092010228026e143b32a4463ed9fa8f86dca266af4bf5f3b2a26e113dbe4e45"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cxxbridge-macro"
|
name = "cxxbridge-macro"
|
||||||
version = "1.0.194"
|
version = "1.0.192"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "e6acc6b5822b9526adfb4fc377b67128fdd60aac757cc4a741a6278603f763cf"
|
checksum = "31d72ebfcd351ae404fb00ff378dfc9571827a00722c9e735c9181aec320ba0a"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"indexmap",
|
"indexmap",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
@@ -1601,9 +1599,9 @@ checksum = "439ee305def115ba05938db6eb1644ff94165c5ab5e9420d1c1bcedbba909391"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "proc-macro2"
|
name = "proc-macro2"
|
||||||
version = "1.0.106"
|
version = "1.0.105"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
|
checksum = "535d180e0ecab6268a3e718bb9fd44db66bbbc256257165fc699dadf70d16fe7"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"unicode-ident",
|
"unicode-ident",
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -16,8 +16,6 @@ anyhow = "1.0.100"
|
|||||||
tui-tree-widget = "0.24.0"
|
tui-tree-widget = "0.24.0"
|
||||||
tui-logger = "0.18.1"
|
tui-logger = "0.18.1"
|
||||||
edtui = "0.11.1"
|
edtui = "0.11.1"
|
||||||
strum = "0.27.2"
|
|
||||||
uuid = { version = "1.19.0", features = ["v4"] }
|
|
||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
# The link_qt_object_files feature is required for statically linking Qt 6.
|
# The link_qt_object_files feature is required for statically linking Qt 6.
|
||||||
|
|||||||
674
LICENSE
674
LICENSE
@@ -1,674 +0,0 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
||||||
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.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
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 <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
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
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
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
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
76
README.md
76
README.md
@@ -1,10 +1,15 @@
|
|||||||
# CLIDE
|
# CLIDE
|
||||||
|
|
||||||
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.
|
CLIDE is a barebones but extendable IDE 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.
|
The core application will provide you with a text editor that can be extended with plugins written in Rust.
|
||||||
|
|
||||||
It's up to you to build your own development environment for your tools. Plugins are planned to be supported in the future for bringing your own language-specific tools or features.
|
The UI is written in QML and compiled to C++ using `cxx`, which is then linked into the Rust application.
|
||||||
Once you've created your plugin, you can submit a pull request to add a link to the git repository for your plugin to the final section in this README if you'd like to contribute.
|
|
||||||
|
It's up to you to build your own development environment for your tools.
|
||||||
|
This project is intended to be a light-weight core application with no language-specific tools or features.
|
||||||
|
To add tools for your purposes, create a plugin that implements the `ClidePlugin` trait. (This is currently under development and not yet available.)
|
||||||
|
Once you've created your plugin, you can submit a pull request to add your plugin to the final section in this README if you'd like to contribute.
|
||||||
|
If this section becomes too large, we may explore other options to distribute plugins.
|
||||||
|
|
||||||
The following packages must be installed before the application will build.
|
The following packages must be installed before the application will build.
|
||||||
In the future, we may provide a minimal installation option that only includes dependencies for the headless TUI.
|
In the future, we may provide a minimal installation option that only includes dependencies for the headless TUI.
|
||||||
@@ -19,69 +24,6 @@ And of course, [Rust](https://www.rust-lang.org/tools/install).
|
|||||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
To install and run clide
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://git.shaunreed.com/shaunrd0/clide
|
|
||||||
cd clide
|
|
||||||
cargo install --path .
|
|
||||||
```
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
Extendable command-line driven development environment written in Rust using the Qt UI framework.
|
|
||||||
If no flags are provided, the GUI editor is launched in a separate process.
|
|
||||||
If no path is provided, the current directory is used.
|
|
||||||
|
|
||||||
Usage: clide [OPTIONS] [PATH]
|
|
||||||
|
|
||||||
Arguments:
|
|
||||||
[PATH] The root directory for the project to open with the clide editor
|
|
||||||
|
|
||||||
Options:
|
|
||||||
-t, --tui Run clide in headless mode
|
|
||||||
-g, --gui Run the clide GUI in the current process, blocking the terminal and showing all output streams
|
|
||||||
-h, --help Print help
|
|
||||||
```
|
|
||||||
|
|
||||||
### TUI
|
|
||||||
|
|
||||||
The TUI is implemented using the ratatui crate and has the typical features you would expect from a text editor.
|
|
||||||
You can browse your project tree, open / close new editor tabs, and save / reload files.
|
|
||||||
Controls for the TUI are listed at the bottom of the window, and update depending on which widget you have focused.
|
|
||||||
For now, there are no language-specific features or plugins available for the TUI – it is only a text editor.
|
|
||||||
|
|
||||||
To run the TUI, pass the `-t` or `--tui` flags.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# With cargo from the project root
|
|
||||||
cargo run -- -t
|
|
||||||
# Or via clide directly after installation
|
|
||||||
clide -t
|
|
||||||
```
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### GUI
|
|
||||||
|
|
||||||
The GUI is still in development. It is at this point a text viewer, instead of a text editor.
|
|
||||||
There are many placeholder buttons and features in the GUI that do nothing when used.
|
|
||||||
|
|
||||||
The GUI is run by default when executing the `clide` application.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# With cargo from the project root
|
|
||||||
cargo run
|
|
||||||
# Or via clide directly after installation
|
|
||||||
clide
|
|
||||||
```
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
It's recommended to use RustRover or Qt Creator for development.
|
It's recommended to use RustRover or Qt Creator for development.
|
||||||
|
|||||||
@@ -58,7 +58,7 @@ ApplicationWindow {
|
|||||||
+ "<p>Project notes <a href=\"http://knoats.com\">knoats.com</a></p>"
|
+ "<p>Project notes <a href=\"http://knoats.com\">knoats.com</a></p>"
|
||||||
+ "<p>This project is developed at <a href=\"http://git.shaunreed.com/shaunrd0/clide\">git.shaunreed.com</a></p>"
|
+ "<p>This project is developed at <a href=\"http://git.shaunreed.com/shaunrd0/clide\">git.shaunreed.com</a></p>"
|
||||||
+ "<p><a href=\"https://github.com/KDAB/cxx-qt\">KDAB CXX-Qt repository</a></p>"
|
+ "<p><a href=\"https://github.com/KDAB/cxx-qt\">KDAB CXX-Qt repository</a></p>"
|
||||||
+ "<p>Copyright (C) 2026 Shaun Reed, all rights reserved.</p>")
|
+ "<p>Copyright (C) 2025 Shaun Reed, all rights reserved.</p>")
|
||||||
color: RustColors.editor_text
|
color: RustColors.editor_text
|
||||||
wrapMode: Text.WordWrap
|
wrapMode: Text.WordWrap
|
||||||
readOnly: true
|
readOnly: true
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ SplitView {
|
|||||||
// The path to the file to show in the text editor.
|
// The path to the file to show in the text editor.
|
||||||
// This is updated by a signal caught within ClideProjectView.
|
// This is updated by a signal caught within ClideProjectView.
|
||||||
// Initialized by the Default trait for the Rust QML singleton FileSystem.
|
// 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.
|
// Customized handle to drag between the Editor and the Console.
|
||||||
handle: Rectangle {
|
handle: Rectangle {
|
||||||
|
|||||||
@@ -7,8 +7,8 @@ import clide.module 1.0
|
|||||||
SplitView {
|
SplitView {
|
||||||
id: root
|
id: root
|
||||||
|
|
||||||
// Path to the directory of the project opened in clide.
|
// Path to the file selected in the tree view.
|
||||||
required property string projectDir
|
default property string selectedFilePath: FileSystem.filePath;
|
||||||
|
|
||||||
Layout.fillHeight: true
|
Layout.fillHeight: true
|
||||||
Layout.fillWidth: true
|
Layout.fillWidth: true
|
||||||
@@ -43,18 +43,13 @@ SplitView {
|
|||||||
anchors.fill: parent
|
anchors.fill: parent
|
||||||
ClideTreeView {
|
ClideTreeView {
|
||||||
id: clideTreeView
|
id: clideTreeView
|
||||||
onFileClicked: path => root.projectDir = path
|
onFileClicked: path => root.selectedFilePath = path
|
||||||
|
|
||||||
// Path to the directory opened in the file explorer.
|
|
||||||
rootDirectory: root.projectDir
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
ClideEditor {
|
ClideEditor {
|
||||||
SplitView.fillWidth: true
|
SplitView.fillWidth: true
|
||||||
|
// Initialize using the Default trait in Rust QML singleton FileSystem.
|
||||||
// Provide a path to the file currently open in the text editor.
|
filePath: root.selectedFilePath
|
||||||
// Initialized using the Default trait in Rust QML singleton FileSystem.
|
|
||||||
filePath: FileSystem.filePath
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,14 +8,13 @@ Rectangle {
|
|||||||
id: root
|
id: root
|
||||||
color: RustColors.explorer_background
|
color: RustColors.explorer_background
|
||||||
|
|
||||||
required property string rootDirectory
|
|
||||||
|
|
||||||
signal fileClicked(string filePath)
|
signal fileClicked(string filePath)
|
||||||
|
|
||||||
TreeView {
|
TreeView {
|
||||||
id: fileSystemTreeView
|
id: fileSystemTreeView
|
||||||
anchors.margins: 15
|
anchors.margins: 15
|
||||||
|
|
||||||
|
// rootIndex: FileSystem.rootIndex
|
||||||
property int lastIndex: -1
|
property int lastIndex: -1
|
||||||
|
|
||||||
model: FileSystem
|
model: FileSystem
|
||||||
@@ -25,8 +24,8 @@ Rectangle {
|
|||||||
clip: true
|
clip: true
|
||||||
|
|
||||||
Component.onCompleted: {
|
Component.onCompleted: {
|
||||||
FileSystem.setDirectory(root.rootDirectory)
|
FileSystem.setDirectory(FileSystem.filePath)
|
||||||
fileSystemTreeView.expandRecursively(0, -1)
|
fileSystemTreeView.expandRecursively(0, 4)
|
||||||
}
|
}
|
||||||
|
|
||||||
// The delegate represents a single entry in the filesystem.
|
// The delegate represents a single entry in the filesystem.
|
||||||
@@ -43,7 +42,9 @@ Rectangle {
|
|||||||
indicator: Image {
|
indicator: Image {
|
||||||
id: directoryIcon
|
id: directoryIcon
|
||||||
|
|
||||||
function setSourceImage() {
|
x: treeDelegate.leftMargin + (treeDelegate.depth * treeDelegate.indentation)
|
||||||
|
anchors.verticalCenter: parent.verticalCenter
|
||||||
|
source: {
|
||||||
let folderOpen = "data:image/svg+xml;utf8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 576 512\"><!--!Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--><path d=\"M88.7 223.8L0 375.8 0 96C0 60.7 28.7 32 64 32l117.5 0c17 0 33.3 6.7 45.3 18.7l26.5 26.5c12 12 28.3 18.7 45.3 18.7L416 96c35.3 0 64 28.7 64 64l0 32-336 0c-22.8 0-43.8 12.1-55.3 31.8zm27.6 16.1C122.1 230 132.6 224 144 224l400 0c11.5 0 22 6.1 27.7 16.1s5.7 22.2-.1 32.1l-112 192C453.9 474 443.4 480 432 480L32 480c-11.5 0-22-6.1-27.7-16.1s-5.7-22.2 .1-32.1l112-192z\"/></svg>";
|
let folderOpen = "data:image/svg+xml;utf8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 576 512\"><!--!Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--><path d=\"M88.7 223.8L0 375.8 0 96C0 60.7 28.7 32 64 32l117.5 0c17 0 33.3 6.7 45.3 18.7l26.5 26.5c12 12 28.3 18.7 45.3 18.7L416 96c35.3 0 64 28.7 64 64l0 32-336 0c-22.8 0-43.8 12.1-55.3 31.8zm27.6 16.1C122.1 230 132.6 224 144 224l400 0c11.5 0 22 6.1 27.7 16.1s5.7 22.2-.1 32.1l-112 192C453.9 474 443.4 480 432 480L32 480c-11.5 0-22-6.1-27.7-16.1s-5.7-22.2 .1-32.1l112-192z\"/></svg>";
|
||||||
let folderClosed = "data:image/svg+xml;utf8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 512 512\"><!--!Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--><path d=\"M64 480H448c35.3 0 64-28.7 64-64V160c0-35.3-28.7-64-64-64H288c-10.1 0-19.6-4.7-25.6-12.8L243.2 57.6C231.1 41.5 212.1 32 192 32H64C28.7 32 0 60.7 0 96V416c0 35.3 28.7 64 64 64z\"/></svg>";
|
let folderClosed = "data:image/svg+xml;utf8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 512 512\"><!--!Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--><path d=\"M64 480H448c35.3 0 64-28.7 64-64V160c0-35.3-28.7-64-64-64H288c-10.1 0-19.6-4.7-25.6-12.8L243.2 57.6C231.1 41.5 212.1 32 192 32H64C28.7 32 0 60.7 0 96V416c0 35.3 28.7 64 64 64z\"/></svg>";
|
||||||
let file = "data:image/svg+xml;utf8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 384 512\"><!--!Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--><path d=\"M0 64C0 28.7 28.7 0 64 0L224 0l0 128c0 17.7 14.3 32 32 32l128 0 0 288c0 35.3-28.7 64-64 64L64 512c-35.3 0-64-28.7-64-64L0 64zm384 64l-128 0L256 0 384 128z\"/></svg>";
|
let file = "data:image/svg+xml;utf8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 384 512\"><!--!Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--><path d=\"M0 64C0 28.7 28.7 0 64 0L224 0l0 128c0 17.7 14.3 32 32 32l128 0 0 288c0 35.3-28.7 64-64 64L64 512c-35.3 0-64-28.7-64-64L0 64zm384 64l-128 0L256 0 384 128z\"/></svg>";
|
||||||
@@ -55,10 +56,6 @@ Rectangle {
|
|||||||
return file
|
return file
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
x: treeDelegate.leftMargin + (treeDelegate.depth * treeDelegate.indentation)
|
|
||||||
anchors.verticalCenter: parent.verticalCenter
|
|
||||||
source: setSourceImage()
|
|
||||||
sourceSize.width: 15
|
sourceSize.width: 15
|
||||||
sourceSize.height: 15
|
sourceSize.height: 15
|
||||||
fillMode: Image.PreserveAspectFit
|
fillMode: Image.PreserveAspectFit
|
||||||
|
|||||||
@@ -13,8 +13,6 @@ ApplicationWindow {
|
|||||||
visible: true
|
visible: true
|
||||||
width: 1200
|
width: 1200
|
||||||
|
|
||||||
required property string appContextPath
|
|
||||||
|
|
||||||
menuBar: ClideMenuBar {
|
menuBar: ClideMenuBar {
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -29,7 +27,6 @@ ApplicationWindow {
|
|||||||
title: qsTr("Error")
|
title: qsTr("Error")
|
||||||
}
|
}
|
||||||
ClideProjectView {
|
ClideProjectView {
|
||||||
projectDir: appWindow.appContextPath
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 204 KiB |
14
src/gui.rs
14
src/gui.rs
@@ -1,25 +1,17 @@
|
|||||||
use crate::AppContext;
|
|
||||||
use anyhow::Result;
|
use anyhow::Result;
|
||||||
use cxx_qt_lib::{QMapPair, QMapPair_QString_QVariant, QString, QVariant};
|
use cxx_qt_lib::QString;
|
||||||
use log::trace;
|
|
||||||
|
|
||||||
pub mod colors;
|
pub mod colors;
|
||||||
pub mod filesystem;
|
pub mod filesystem;
|
||||||
|
|
||||||
pub fn run(app_context: AppContext) -> Result<()> {
|
pub fn run(root_path: std::path::PathBuf) -> Result<()> {
|
||||||
trace!(target:"gui::run()", "Starting the GUI editor at {:?}", app_context.path);
|
println!("Starting the GUI editor at {:?}", root_path);
|
||||||
|
|
||||||
use cxx_qt_lib::{QGuiApplication, QQmlApplicationEngine, QUrl};
|
use cxx_qt_lib::{QGuiApplication, QQmlApplicationEngine, QUrl};
|
||||||
|
|
||||||
let mut app = QGuiApplication::new();
|
let mut app = QGuiApplication::new();
|
||||||
let mut engine = QQmlApplicationEngine::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() {
|
if let Some(engine) = engine.as_mut() {
|
||||||
engine.add_import_path(&QString::from("qml/"));
|
engine.add_import_path(&QString::from("qml/"));
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -73,10 +73,10 @@ impl qobject::FileSystem {
|
|||||||
return QString::default();
|
return QString::default();
|
||||||
}
|
}
|
||||||
if !fs::metadata(path.to_string())
|
if !fs::metadata(path.to_string())
|
||||||
.expect(format!("Failed to get file metadata {path:?}").as_str())
|
.expect(format!("Failed to get file metadata {}", path).as_str())
|
||||||
.is_file()
|
.is_file()
|
||||||
{
|
{
|
||||||
warn!(target:"FileSystem", "Attempted to open file {path:?} that is not a valid file");
|
warn!("Attempted to open file {} that is not a valid file", path);
|
||||||
return QString::default();
|
return QString::default();
|
||||||
}
|
}
|
||||||
let ss = SyntaxSet::load_defaults_nonewlines();
|
let ss = SyntaxSet::load_defaults_nonewlines();
|
||||||
@@ -118,7 +118,7 @@ impl qobject::FileSystem {
|
|||||||
fn set_directory(self: std::pin::Pin<&mut Self>, path: &QString) -> QModelIndex {
|
fn set_directory(self: std::pin::Pin<&mut Self>, path: &QString) -> QModelIndex {
|
||||||
if !path.is_empty()
|
if !path.is_empty()
|
||||||
&& fs::metadata(path.to_string())
|
&& fs::metadata(path.to_string())
|
||||||
.expect(format!("Failed to get metadata for path {path:?}").as_str())
|
.expect(format!("Failed to get metadata for path {}", path).as_str())
|
||||||
.is_dir()
|
.is_dir()
|
||||||
{
|
{
|
||||||
self.set_root_path(path)
|
self.set_root_path(path)
|
||||||
|
|||||||
96
src/main.rs
96
src/main.rs
@@ -1,11 +1,14 @@
|
|||||||
use anyhow::{Context, Result, anyhow};
|
use anyhow::{Context, Result};
|
||||||
use clap::Parser;
|
use clap::Parser;
|
||||||
use log::{info, trace};
|
use ratatui::Terminal;
|
||||||
|
use ratatui::backend::CrosstermBackend;
|
||||||
|
use std::io::stdout;
|
||||||
use std::process::{Command, Stdio};
|
use std::process::{Command, Stdio};
|
||||||
|
use crate::tui::Tui;
|
||||||
|
|
||||||
pub mod gui;
|
pub mod gui;
|
||||||
pub mod tui;
|
pub mod tui;
|
||||||
/// Extendable command-line driven development environment written in Rust using the Qt UI framework.
|
/// Command line interface IDE with full GUI and headless modes.
|
||||||
/// If no flags are provided, the GUI editor is launched in a separate process.
|
/// If no flags are provided, the GUI editor is launched in a separate process.
|
||||||
/// If no path is provided, the current directory is used.
|
/// If no path is provided, the current directory is used.
|
||||||
#[derive(Parser, Debug)]
|
#[derive(Parser, Debug)]
|
||||||
@@ -24,67 +27,34 @@ struct Cli {
|
|||||||
pub gui: bool,
|
pub gui: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Cli {
|
|
||||||
fn run_mode(&self) -> Result<RunMode> {
|
|
||||||
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<Self> {
|
|
||||||
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<()> {
|
fn main() -> Result<()> {
|
||||||
let args = Cli::parse();
|
let args = Cli::parse();
|
||||||
let app_context = AppContext::new(args)?;
|
|
||||||
match app_context.run_mode {
|
let root_path = match args.path {
|
||||||
RunMode::GuiAttached => gui::run(app_context),
|
// If the CLI was provided a directory, convert it to absolute.
|
||||||
RunMode::Tui => tui::run(app_context),
|
Some(path) => std::path::absolute(path)?,
|
||||||
RunMode::Gui => {
|
// If no path was provided, use the current directory.
|
||||||
trace!(target:"main()", "Starting GUI in a new process");
|
None => std::env::current_dir().unwrap_or(
|
||||||
Command::new(std::env::current_exe()?)
|
// If we can't find the CWD, attempt to open the home directory.
|
||||||
.args(&["--gui", app_context.path.to_str().unwrap()])
|
dirs::home_dir().context("Failed to obtain home directory")?,
|
||||||
.stdout(Stdio::null())
|
),
|
||||||
.stderr(Stdio::null())
|
};
|
||||||
.stdin(Stdio::null())
|
|
||||||
.spawn()
|
match args.gui {
|
||||||
.context("Failed to start GUI")
|
true => gui::run(root_path),
|
||||||
.map(|_| ())
|
false => match args.tui {
|
||||||
}
|
// Open the TUI editor if requested, otherwise use the QML GUI by default.
|
||||||
|
true => Ok(Tui::new(root_path)?.start()?),
|
||||||
|
false => {
|
||||||
|
// Relaunch the CLIDE GUI in a separate 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(())
|
||||||
|
}
|
||||||
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
40
src/tui.rs
40
src/tui.rs
@@ -1,15 +1,11 @@
|
|||||||
mod about;
|
|
||||||
mod app;
|
mod app;
|
||||||
mod component;
|
mod component;
|
||||||
mod editor;
|
mod editor;
|
||||||
mod editor_tab;
|
|
||||||
mod explorer;
|
mod explorer;
|
||||||
mod logger;
|
mod logger;
|
||||||
mod menu_bar;
|
|
||||||
|
|
||||||
use crate::AppContext;
|
|
||||||
use anyhow::{Context, Result};
|
use anyhow::{Context, Result};
|
||||||
use log::{LevelFilter, debug, info, trace};
|
use log::{LevelFilter, debug};
|
||||||
use ratatui::Terminal;
|
use ratatui::Terminal;
|
||||||
use ratatui::backend::CrosstermBackend;
|
use ratatui::backend::CrosstermBackend;
|
||||||
use ratatui::crossterm::event::{
|
use ratatui::crossterm::event::{
|
||||||
@@ -24,45 +20,34 @@ use tui_logger::{
|
|||||||
TuiLoggerFile, TuiLoggerLevelOutput, init_logger, set_default_level, set_log_file,
|
TuiLoggerFile, TuiLoggerLevelOutput, init_logger, set_default_level, set_log_file,
|
||||||
};
|
};
|
||||||
|
|
||||||
struct Tui {
|
pub struct Tui {
|
||||||
terminal: Terminal<CrosstermBackend<Stdout>>,
|
terminal: Terminal<CrosstermBackend<Stdout>>,
|
||||||
root_path: std::path::PathBuf,
|
root_path: std::path::PathBuf,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn run(app_context: AppContext) -> Result<()> {
|
|
||||||
trace!(target:Tui::ID, "Starting TUI");
|
|
||||||
Tui::new(app_context)?.start()
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Tui {
|
impl Tui {
|
||||||
pub const ID: &str = "Tui";
|
pub fn new(root_path: std::path::PathBuf) -> Result<Self> {
|
||||||
|
|
||||||
fn new(app_context: AppContext) -> Result<Self> {
|
|
||||||
trace!(target:Self::ID, "Building {}", Self::ID);
|
|
||||||
init_logger(LevelFilter::Trace)?;
|
init_logger(LevelFilter::Trace)?;
|
||||||
set_default_level(LevelFilter::Trace);
|
set_default_level(LevelFilter::Trace);
|
||||||
debug!(target:Self::ID, "Logging initialized");
|
debug!(target:"Tui", "Logging initialized");
|
||||||
|
|
||||||
let mut dir = env::temp_dir();
|
let mut dir = env::temp_dir();
|
||||||
dir.push("clide.log");
|
dir.push("clide.log");
|
||||||
let file_options = TuiLoggerFile::new(
|
let file_options = TuiLoggerFile::new(dir.to_str().unwrap())
|
||||||
dir.to_str()
|
.output_level(Some(TuiLoggerLevelOutput::Abbreviated))
|
||||||
.context("Failed to set temp directory for file logging")?,
|
.output_file(false)
|
||||||
)
|
.output_separator(':');
|
||||||
.output_level(Some(TuiLoggerLevelOutput::Abbreviated))
|
|
||||||
.output_file(false)
|
|
||||||
.output_separator(':');
|
|
||||||
set_log_file(file_options);
|
set_log_file(file_options);
|
||||||
debug!(target:Self::ID, "Logging to file: {dir:?}");
|
debug!(target:"Tui", "Logging to file: {}", dir.to_str().unwrap());
|
||||||
|
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
terminal: Terminal::new(CrosstermBackend::new(stdout()))?,
|
terminal: Terminal::new(CrosstermBackend::new(stdout()))?,
|
||||||
root_path: app_context.path,
|
root_path,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
fn start(self) -> Result<()> {
|
pub fn start(self) -> Result<()> {
|
||||||
info!(target:Self::ID, "Starting the TUI editor at {:?}", self.root_path);
|
println!("Starting the TUI editor at {:?}", self.root_path);
|
||||||
ratatui::crossterm::execute!(
|
ratatui::crossterm::execute!(
|
||||||
stdout(),
|
stdout(),
|
||||||
EnterAlternateScreen,
|
EnterAlternateScreen,
|
||||||
@@ -79,7 +64,6 @@ impl Tui {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn stop() -> Result<()> {
|
fn stop() -> Result<()> {
|
||||||
info!(target:Self::ID, "Stopping the TUI editor");
|
|
||||||
disable_raw_mode()?;
|
disable_raw_mode()?;
|
||||||
ratatui::crossterm::execute!(
|
ratatui::crossterm::execute!(
|
||||||
stdout(),
|
stdout(),
|
||||||
|
|||||||
@@ -1,88 +0,0 @@
|
|||||||
use ratatui::buffer::Buffer;
|
|
||||||
use ratatui::layout::{Constraint, Direction, Layout, Rect};
|
|
||||||
use ratatui::text::{Line, Span};
|
|
||||||
use ratatui::widgets::{Block, Borders, Clear, Padding, Paragraph, Widget, Wrap};
|
|
||||||
|
|
||||||
pub struct About {}
|
|
||||||
|
|
||||||
impl About {
|
|
||||||
#[allow(unused)]
|
|
||||||
pub const ID: &str = "About";
|
|
||||||
|
|
||||||
pub fn new() -> Self {
|
|
||||||
// trace!(target:Self::id(), "Building {}", Self::id());
|
|
||||||
Self {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Widget for About {
|
|
||||||
fn render(self, area: Rect, buf: &mut Buffer)
|
|
||||||
where
|
|
||||||
Self: Sized,
|
|
||||||
{
|
|
||||||
let chunks = Layout::default()
|
|
||||||
.direction(Direction::Vertical)
|
|
||||||
.constraints([
|
|
||||||
Constraint::Fill(1), // Image Layout
|
|
||||||
Constraint::Fill(2), // Description
|
|
||||||
])
|
|
||||||
.split(area);
|
|
||||||
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<Line> = 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<Line> = 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()
|
|
||||||
.borders(Borders::NONE)
|
|
||||||
.padding(Padding::bottom(0)),
|
|
||||||
)
|
|
||||||
.wrap(Wrap { trim: false })
|
|
||||||
.centered()
|
|
||||||
.render(kilroy_rect, buf);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
494
src/tui/app.rs
494
src/tui/app.rs
@@ -1,72 +1,129 @@
|
|||||||
use crate::tui::about::About;
|
use crate::tui::component::{Action, Component};
|
||||||
use crate::tui::app::AppComponent::{AppEditor, AppExplorer, AppLogger};
|
use crate::tui::editor::Editor;
|
||||||
use crate::tui::component::{Action, Component, Focus, FocusState, Visibility, VisibleState};
|
|
||||||
use crate::tui::editor_tab::EditorTab;
|
|
||||||
use crate::tui::explorer::Explorer;
|
use crate::tui::explorer::Explorer;
|
||||||
use crate::tui::logger::Logger;
|
use crate::tui::logger::Logger;
|
||||||
use crate::tui::menu_bar::MenuBar;
|
use anyhow::{Context, Result, anyhow, bail};
|
||||||
use AppComponent::AppMenuBar;
|
use log::{debug, error, info, trace, warn};
|
||||||
use anyhow::{Context, Result};
|
|
||||||
use log::{error, info, trace};
|
|
||||||
use ratatui::DefaultTerminal;
|
|
||||||
use ratatui::buffer::Buffer;
|
use ratatui::buffer::Buffer;
|
||||||
use ratatui::crossterm::event;
|
use ratatui::crossterm::event;
|
||||||
use ratatui::crossterm::event::{
|
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent, KeyEventKind, KeyModifiers};
|
||||||
Event, KeyCode, KeyEvent, KeyEventKind, KeyModifiers, MouseButton, MouseEventKind,
|
|
||||||
};
|
|
||||||
use ratatui::layout::{Constraint, Direction, Layout, Rect};
|
use ratatui::layout::{Constraint, Direction, Layout, Rect};
|
||||||
use ratatui::prelude::{Color, Widget};
|
use ratatui::prelude::{Color, Style, Widget};
|
||||||
use ratatui::widgets::{Paragraph, Wrap};
|
use ratatui::widgets::{Block, Borders, Padding, Paragraph, Tabs, Wrap};
|
||||||
use std::path::{Path, PathBuf};
|
use ratatui::{DefaultTerminal, symbols};
|
||||||
|
use std::path::PathBuf;
|
||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq)]
|
// TODO: Need a way to dynamically run Widget::render on all widgets.
|
||||||
pub enum AppComponent {
|
// TODO: + Need a way to map Rect to Component::id() to position each widget?
|
||||||
AppEditor,
|
// TODO: Need a way to dynamically run Component methods on all widgets.
|
||||||
AppExplorer,
|
pub enum AppComponents<'a> {
|
||||||
AppLogger,
|
AppEditor(Editor),
|
||||||
AppMenuBar,
|
AppExplorer(Explorer<'a>),
|
||||||
|
AppLogger(Logger),
|
||||||
|
AppComponent(Box<dyn Component>),
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Usage: get_component_mut::<Editor>() OR get_component::<Editor>()
|
||||||
|
///
|
||||||
|
/// Implementing this trait for each AppComponent allows for easy lookup in the vector.
|
||||||
|
trait ComponentOf<T> {
|
||||||
|
fn as_ref(&self) -> Option<&T>;
|
||||||
|
fn as_mut(&mut self) -> Option<&mut T>;
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a> ComponentOf<Logger> for AppComponents<'a> {
|
||||||
|
fn as_ref(&self) -> Option<&Logger> {
|
||||||
|
if let AppComponents::AppLogger(ref e) = *self {
|
||||||
|
return Some(e);
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
|
fn as_mut(&mut self) -> Option<&mut Logger> {
|
||||||
|
if let AppComponents::AppLogger(ref mut e) = *self {
|
||||||
|
return Some(e);
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a> ComponentOf<Editor> for AppComponents<'a> {
|
||||||
|
fn as_ref(&self) -> Option<&Editor> {
|
||||||
|
if let AppComponents::AppEditor(ref e) = *self {
|
||||||
|
return Some(e);
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
|
fn as_mut(&mut self) -> Option<&mut Editor> {
|
||||||
|
if let AppComponents::AppEditor(ref mut e) = *self {
|
||||||
|
return Some(e);
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a> ComponentOf<Explorer<'a>> for AppComponents<'a> {
|
||||||
|
fn as_ref(&self) -> Option<&Explorer<'a>> {
|
||||||
|
if let AppComponents::AppExplorer(ref e) = *self {
|
||||||
|
return Some(e);
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
|
fn as_mut(&mut self) -> Option<&mut Explorer<'a>> {
|
||||||
|
if let AppComponents::AppExplorer(ref mut e) = *self {
|
||||||
|
return Some(e);
|
||||||
|
}
|
||||||
|
None
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub struct App<'a> {
|
pub struct App<'a> {
|
||||||
editor_tab: EditorTab,
|
components: Vec<AppComponents<'a>>,
|
||||||
explorer: Explorer<'a>,
|
|
||||||
logger: Logger,
|
|
||||||
menu_bar: MenuBar,
|
|
||||||
last_active: AppComponent,
|
|
||||||
about: bool,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> App<'a> {
|
impl<'a> App<'a> {
|
||||||
pub const ID: &'static str = "App";
|
|
||||||
|
|
||||||
pub fn new(root_path: PathBuf) -> Result<Self> {
|
pub fn new(root_path: PathBuf) -> Result<Self> {
|
||||||
trace!(target:Self::ID, "Building {}", Self::ID);
|
let mut app = Self {
|
||||||
let app = Self {
|
components: vec![
|
||||||
editor_tab: EditorTab::new(),
|
AppComponents::AppExplorer(Explorer::new(&root_path)?),
|
||||||
explorer: Explorer::new(&root_path)?,
|
AppComponents::AppEditor(Editor::new()),
|
||||||
logger: Logger::new(),
|
AppComponents::AppLogger(Logger::new()),
|
||||||
menu_bar: MenuBar::new(),
|
],
|
||||||
last_active: AppEditor,
|
|
||||||
about: false,
|
|
||||||
};
|
};
|
||||||
|
app.get_component_mut::<Editor>()
|
||||||
|
.unwrap()
|
||||||
|
.set_contents(&root_path.join("src/tui/app.rs"))
|
||||||
|
.context(format!(
|
||||||
|
"Failed to initialize editor contents to path: {}",
|
||||||
|
root_path.to_string_lossy()
|
||||||
|
))?;
|
||||||
Ok(app)
|
Ok(app)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Logic that should be executed once on application startup.
|
fn get_component<T>(&self) -> Option<&T>
|
||||||
pub fn start(&mut self) -> Result<()> {
|
where
|
||||||
trace!(target:Self::ID, "Starting App");
|
AppComponents<'a>: ComponentOf<T>,
|
||||||
Ok(())
|
{
|
||||||
|
self.components.iter().find_map(|c| c.as_ref())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_component_mut<T>(&mut self) -> Option<&mut T>
|
||||||
|
where
|
||||||
|
AppComponents<'a>: ComponentOf<T>,
|
||||||
|
{
|
||||||
|
self.components.iter_mut().find_map(|c| c.as_mut())
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn run(mut self, mut terminal: DefaultTerminal) -> Result<()> {
|
pub fn run(mut self, mut terminal: DefaultTerminal) -> Result<()> {
|
||||||
self.start()?;
|
|
||||||
trace!(target:Self::ID, "Entering App run loop");
|
|
||||||
loop {
|
loop {
|
||||||
|
self.refresh_editor_contents()
|
||||||
|
.context("Failed to refresh editor contents.")?;
|
||||||
|
|
||||||
terminal.draw(|f| {
|
terminal.draw(|f| {
|
||||||
f.render_widget(&mut self, f.area());
|
f.render_widget(&mut self, f.area());
|
||||||
})?;
|
})?;
|
||||||
|
|
||||||
|
// TODO: Handle events based on which component is active.
|
||||||
if event::poll(Duration::from_millis(250)).context("event poll failed")? {
|
if event::poll(Duration::from_millis(250)).context("event poll failed")? {
|
||||||
match self.handle_event(event::read()?)? {
|
match self.handle_event(event::read()?)? {
|
||||||
Action::Quit => break,
|
Action::Quit => break,
|
||||||
@@ -80,163 +137,119 @@ impl<'a> App<'a> {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn draw_bottom_status(&self, area: Rect, buf: &mut Buffer) {
|
fn draw_status(&self, area: Rect, buf: &mut Buffer) {
|
||||||
// Determine help text from the most recently focused component.
|
// TODO: Status bar should have drop down menus
|
||||||
let help = match self.last_active {
|
Tabs::new(["File", "Edit", "View", "Help"])
|
||||||
AppEditor => match self.editor_tab.current_editor() {
|
.style(Style::default())
|
||||||
Some(editor) => editor.component_state.help_text.clone(),
|
.block(Block::default().borders(Borders::ALL))
|
||||||
None => {
|
.render(area, buf);
|
||||||
if !self.editor_tab.is_empty() {
|
}
|
||||||
error!(target:Self::ID, "Failed to get Editor while drawing bottom status bar");
|
|
||||||
}
|
fn draw_tabs(&self, area: Rect, buf: &mut Buffer) {
|
||||||
"Failed to get current Editor while getting widget help text".to_string()
|
// Determine the tab title from the current file (or use a fallback).
|
||||||
}
|
let mut title: Option<&str> = None;
|
||||||
},
|
if let Some(editor) = self.get_component::<Editor>() {
|
||||||
AppExplorer => self.explorer.component_state.help_text.clone(),
|
title = editor
|
||||||
AppLogger => self.logger.component_state.help_text.clone(),
|
.file_path
|
||||||
AppMenuBar => self.menu_bar.component_state.help_text.clone(),
|
.as_ref()
|
||||||
};
|
.and_then(|p| p.file_name())
|
||||||
Paragraph::new(
|
.and_then(|s| s.to_str())
|
||||||
concat!(
|
}
|
||||||
"ALT+Q: Focus project explorer | ALT+W: Focus editor | ALT+E: Focus logger |",
|
|
||||||
" ALT+R: Focus menu bar | CTRL+C: Quit\n"
|
Tabs::new(vec![title.unwrap_or("Unknown")])
|
||||||
|
.divider(symbols::DOT)
|
||||||
|
.block(
|
||||||
|
Block::default()
|
||||||
|
.borders(Borders::NONE)
|
||||||
|
.padding(Padding::new(0, 0, 0, 0)),
|
||||||
)
|
)
|
||||||
.to_string()
|
.highlight_style(Style::default().fg(Color::LightRed))
|
||||||
+ help.as_str(),
|
.render(area, buf);
|
||||||
)
|
|
||||||
.style(Color::Gray)
|
|
||||||
.wrap(Wrap { trim: false })
|
|
||||||
.centered()
|
|
||||||
.render(area, buf);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn clear_focus(&mut self) {
|
/// Refresh the contents of the editor to match the selected TreeItem in the file Explorer.
|
||||||
info!(target:Self::ID, "Clearing all widget focus");
|
/// If the selected item is not a file, this does nothing.
|
||||||
self.explorer.component_state.set_focus(Focus::Inactive);
|
fn refresh_editor_contents(&mut self) -> Result<()> {
|
||||||
self.explorer.component_state.set_focus(Focus::Inactive);
|
// Use the currently selected TreeItem or get an absolute path to this source file.
|
||||||
self.logger.component_state.set_focus(Focus::Inactive);
|
let selected_pathbuf = match self.get_component::<Explorer>().unwrap().selected() {
|
||||||
self.menu_bar.component_state.set_focus(Focus::Inactive);
|
Ok(path) => PathBuf::from(path),
|
||||||
match self.editor_tab.current_editor_mut() {
|
Err(_) => PathBuf::from(std::path::absolute(file!())?.to_string_lossy().to_string()),
|
||||||
None => {
|
};
|
||||||
error!(target:Self::ID, "Failed to get current Editor while clearing focus")
|
let editor = self
|
||||||
|
.get_component_mut::<Editor>()
|
||||||
|
.context("Failed to get active editor while refreshing contents.")?;
|
||||||
|
if let Some(current_file_path) = editor.file_path.clone() {
|
||||||
|
if selected_pathbuf == current_file_path || !selected_pathbuf.is_file() {
|
||||||
|
return Ok(());
|
||||||
}
|
}
|
||||||
Some(editor) => editor.component_state.set_focus(Focus::Inactive),
|
return editor.set_contents(&selected_pathbuf);
|
||||||
}
|
}
|
||||||
}
|
bail!("Failed to refresh editor contents")
|
||||||
|
|
||||||
fn change_focus(&mut self, focus: AppComponent) {
|
|
||||||
info!(target:Self::ID, "Changing widget focus to {:?}", focus);
|
|
||||||
self.clear_focus();
|
|
||||||
match focus {
|
|
||||||
AppEditor => match self.editor_tab.current_editor_mut() {
|
|
||||||
None => {
|
|
||||||
error!(target:Self::ID, "Failed to get current Editor while changing focus")
|
|
||||||
}
|
|
||||||
Some(editor) => editor.component_state.set_focus(Focus::Active),
|
|
||||||
},
|
|
||||||
AppExplorer => self.explorer.component_state.set_focus(Focus::Active),
|
|
||||||
AppLogger => self.logger.component_state.set_focus(Focus::Active),
|
|
||||||
AppMenuBar => self.menu_bar.component_state.set_focus(Focus::Active),
|
|
||||||
}
|
|
||||||
self.last_active = focus;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TODO: Separate complex components into their own widgets.
|
||||||
impl<'a> Widget for &mut App<'a> {
|
impl<'a> Widget for &mut App<'a> {
|
||||||
fn render(self, area: Rect, buf: &mut Buffer)
|
fn render(self, area: Rect, buf: &mut Buffer)
|
||||||
where
|
where
|
||||||
Self: Sized,
|
Self: Sized,
|
||||||
{
|
{
|
||||||
let vertical_constraints = match self.logger.component_state.vis {
|
|
||||||
Visibility::Visible => {
|
|
||||||
vec![
|
|
||||||
Constraint::Length(3), // top status bar
|
|
||||||
Constraint::Percentage(70), // horizontal layout
|
|
||||||
Constraint::Fill(1), // terminal
|
|
||||||
Constraint::Length(3), // bottom status bar
|
|
||||||
]
|
|
||||||
}
|
|
||||||
Visibility::Hidden => {
|
|
||||||
vec![
|
|
||||||
Constraint::Length(3), // top status bar
|
|
||||||
Constraint::Fill(1), // horizontal layout
|
|
||||||
Constraint::Length(3), // bottom status bar
|
|
||||||
]
|
|
||||||
}
|
|
||||||
};
|
|
||||||
let vertical = Layout::default()
|
let vertical = Layout::default()
|
||||||
.direction(Direction::Vertical)
|
.direction(Direction::Vertical)
|
||||||
.constraints(vertical_constraints)
|
.constraints([
|
||||||
|
Constraint::Length(3), // status bar
|
||||||
|
Constraint::Percentage(70), // horizontal layout
|
||||||
|
Constraint::Percentage(30), // terminal
|
||||||
|
])
|
||||||
.split(area);
|
.split(area);
|
||||||
|
|
||||||
let horizontal_constraints = match self.explorer.component_state.vis {
|
|
||||||
Visibility::Visible => {
|
|
||||||
vec![
|
|
||||||
Constraint::Max(30), // File explorer with a max width of 30 characters.
|
|
||||||
Constraint::Fill(1), // Editor fills the remaining space.
|
|
||||||
]
|
|
||||||
}
|
|
||||||
Visibility::Hidden => {
|
|
||||||
vec![
|
|
||||||
Constraint::Fill(1), // Editor fills the remaining space.
|
|
||||||
]
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// The index used for vertical here does not care if the Logger is Visible or not.
|
|
||||||
let horizontal = Layout::default()
|
let horizontal = Layout::default()
|
||||||
.direction(Direction::Horizontal)
|
.direction(Direction::Horizontal)
|
||||||
.constraints(horizontal_constraints)
|
.constraints([
|
||||||
|
Constraint::Max(30), // File explorer with a max width of 30 characters.
|
||||||
|
Constraint::Fill(1), // Editor fills the remaining space.
|
||||||
|
])
|
||||||
.split(vertical[1]);
|
.split(vertical[1]);
|
||||||
match self.explorer.component_state.vis {
|
|
||||||
Visibility::Visible => {
|
|
||||||
let editor_layout = Layout::default()
|
|
||||||
.direction(Direction::Vertical)
|
|
||||||
.constraints([
|
|
||||||
Constraint::Length(1), // Editor tabs.
|
|
||||||
Constraint::Fill(1), // Editor contents.
|
|
||||||
])
|
|
||||||
.split(horizontal[1]);
|
|
||||||
self.editor_tab
|
|
||||||
.render(editor_layout[0], editor_layout[1], buf);
|
|
||||||
self.explorer.render(horizontal[0], buf);
|
|
||||||
}
|
|
||||||
Visibility::Hidden => {
|
|
||||||
let editor_layout = Layout::default()
|
|
||||||
.direction(Direction::Vertical)
|
|
||||||
.constraints([
|
|
||||||
Constraint::Length(1), // Editor tabs.
|
|
||||||
Constraint::Fill(1), // Editor contents.
|
|
||||||
])
|
|
||||||
.split(horizontal[0]);
|
|
||||||
self.editor_tab
|
|
||||||
.render(editor_layout[0], editor_layout[1], buf);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
match self.logger.component_state.vis {
|
let editor_layout = Layout::default()
|
||||||
// Index 1 of vertical is rendered with the horizontal layout above.
|
.direction(Direction::Vertical)
|
||||||
Visibility::Visible => {
|
.constraints([
|
||||||
self.logger.render(vertical[2], buf);
|
Constraint::Length(1), // Editor tabs.
|
||||||
self.draw_bottom_status(vertical[3], buf);
|
Constraint::Fill(1), // Editor contents.
|
||||||
// The title bar is rendered last to overlay any popups created for drop-down menus.
|
])
|
||||||
self.menu_bar.render(vertical[0], buf);
|
.split(horizontal[1]);
|
||||||
}
|
|
||||||
Visibility::Hidden => {
|
|
||||||
self.draw_bottom_status(vertical[2], buf);
|
|
||||||
// The title bar is rendered last to overlay any popups created for drop-down menus.
|
|
||||||
self.menu_bar.render(vertical[0], buf);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if self.about {
|
self.draw_status(vertical[0], buf);
|
||||||
let about_area = area.centered(Constraint::Percentage(40), Constraint::Percentage(50));
|
self.draw_tabs(editor_layout[0], buf);
|
||||||
About::new().render(about_area, buf);
|
let id = self.id().to_string();
|
||||||
|
for component in &mut self.components {
|
||||||
|
match component {
|
||||||
|
AppComponents::AppEditor(editor) => editor.render(editor_layout[1], buf),
|
||||||
|
AppComponents::AppExplorer(explorer) => {
|
||||||
|
explorer
|
||||||
|
.render(horizontal[0], buf)
|
||||||
|
.context("Failed to render Explorer")
|
||||||
|
.unwrap_or_else(|e| error!(target:id.as_str(), "{}", e));
|
||||||
|
}
|
||||||
|
AppComponents::AppLogger(logger) => logger.render(vertical[2], buf),
|
||||||
|
AppComponents::AppComponent(_) => {}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> Component for App<'a> {
|
impl<'a> Component for App<'a> {
|
||||||
|
fn id(&self) -> &str {
|
||||||
|
"App"
|
||||||
|
}
|
||||||
|
|
||||||
|
/// TODO: Get active widget with some Component trait function helper?
|
||||||
|
/// trait Component { fn get_state() -> ComponentState; }
|
||||||
|
/// if component.get_state() = ComponentState::Active { component.handle_event(); }
|
||||||
|
///
|
||||||
|
/// App could then provide helpers for altering Component state based on TUI grouping..
|
||||||
|
/// (such as editor tabs, file explorer, status bars, etc..)
|
||||||
|
///
|
||||||
/// Handles events for the App and delegates to attached Components.
|
/// Handles events for the App and delegates to attached Components.
|
||||||
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
||||||
// Handle events in the primary application.
|
// Handle events in the primary application.
|
||||||
@@ -249,131 +262,40 @@ impl<'a> Component for App<'a> {
|
|||||||
_ => {}
|
_ => {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handle events for all components.
|
// Handle events for all components.
|
||||||
let action = match self.last_active {
|
for component in &mut self.components {
|
||||||
AppEditor => self.editor_tab.handle_event(event.clone())?,
|
let action = match component {
|
||||||
AppExplorer => self.explorer.handle_event(event.clone())?,
|
AppComponents::AppEditor(editor) => editor.handle_event(event.clone())?,
|
||||||
AppLogger => self.logger.handle_event(event.clone())?,
|
AppComponents::AppExplorer(explorer) => explorer.handle_event(event.clone())?,
|
||||||
AppMenuBar => self.menu_bar.handle_event(event.clone())?,
|
AppComponents::AppComponent(comp) => comp.handle_event(event.clone())?,
|
||||||
};
|
AppComponents::AppLogger(logger) => logger.handle_event(event.clone())?,
|
||||||
|
};
|
||||||
// Components should always handle mouse events for click interaction.
|
// Actions returned here abort the input handling iteration.
|
||||||
if let Some(mouse) = event.as_mouse_event() {
|
match action {
|
||||||
if mouse.kind == MouseEventKind::Down(MouseButton::Left) {
|
Action::Quit | Action::Handled => return Ok(action),
|
||||||
if let Some(editor) = self.editor_tab.current_editor_mut() {
|
_ => {}
|
||||||
editor.handle_mouse_events(mouse)?;
|
|
||||||
}
|
|
||||||
self.explorer.handle_mouse_events(mouse)?;
|
|
||||||
self.logger.handle_mouse_events(mouse)?;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Ok(Action::Noop)
|
||||||
// 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_tab.current_editor_mut() {
|
|
||||||
None => {
|
|
||||||
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}");
|
|
||||||
Ok(Action::Noop)
|
|
||||||
}
|
|
||||||
},
|
|
||||||
},
|
|
||||||
Action::OpenTab => {
|
|
||||||
if let Ok(path) = self.explorer.selected() {
|
|
||||||
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_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_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");
|
|
||||||
Ok(Action::Noop)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Action::ShowHideLogger => {
|
|
||||||
self.logger.component_state.toggle_visible();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
Action::ShowHideExplorer => {
|
|
||||||
self.explorer.component_state.toggle_visible();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
Action::ShowHideAbout => {
|
|
||||||
self.about = !self.about;
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
_ => Ok(Action::Noop),
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Handles key events for the App Component only.
|
/// Handles key events for the App Component only.
|
||||||
fn handle_key_events(&mut self, key: KeyEvent) -> Result<Action> {
|
fn handle_key_events(&mut self, key: KeyEvent) -> Result<Action> {
|
||||||
match key.code {
|
|
||||||
// If the ESC key is pressed with the About page open, hide it.
|
|
||||||
KeyCode::Esc | KeyCode::Char('q') => {
|
|
||||||
if self.about {
|
|
||||||
self.about = false;
|
|
||||||
return Ok(Action::Handled);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
|
|
||||||
match key {
|
match key {
|
||||||
KeyEvent {
|
KeyEvent {
|
||||||
code: KeyCode::Char('q'),
|
code: KeyCode::Char('l'),
|
||||||
modifiers: KeyModifiers::ALT,
|
modifiers: KeyModifiers::CONTROL,
|
||||||
kind: KeyEventKind::Press,
|
kind: KeyEventKind::Press,
|
||||||
state: _state,
|
state: _state,
|
||||||
} => {
|
} => {
|
||||||
self.change_focus(AppExplorer);
|
// Some example logs for testing.
|
||||||
Ok(Action::Handled)
|
error!(target:self.id(), "an error");
|
||||||
}
|
warn!(target:self.id(), "a warning");
|
||||||
KeyEvent {
|
info!(target:self.id(), "a two line info\nsecond line");
|
||||||
code: KeyCode::Char('w'),
|
debug!(target:self.id(), "a debug");
|
||||||
modifiers: KeyModifiers::ALT,
|
trace!(target:self.id(), "a trace");
|
||||||
kind: KeyEventKind::Press,
|
Ok(Action::Noop)
|
||||||
state: _state,
|
|
||||||
} => {
|
|
||||||
self.change_focus(AppEditor);
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
KeyEvent {
|
|
||||||
code: KeyCode::Char('e'),
|
|
||||||
modifiers: KeyModifiers::ALT,
|
|
||||||
kind: KeyEventKind::Press,
|
|
||||||
state: _state,
|
|
||||||
} => {
|
|
||||||
self.change_focus(AppLogger);
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
KeyEvent {
|
|
||||||
code: KeyCode::Char('r'),
|
|
||||||
modifiers: KeyModifiers::ALT,
|
|
||||||
kind: KeyEventKind::Press,
|
|
||||||
state: _state,
|
|
||||||
} => {
|
|
||||||
self.change_focus(AppMenuBar);
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
}
|
||||||
KeyEvent {
|
KeyEvent {
|
||||||
code: KeyCode::Char('c'),
|
code: KeyCode::Char('c'),
|
||||||
|
|||||||
@@ -1,11 +1,7 @@
|
|||||||
#![allow(dead_code, unused_variables)]
|
#![allow(dead_code, unused_variables)]
|
||||||
|
|
||||||
use crate::tui::component::Focus::Inactive;
|
|
||||||
use Focus::Active;
|
|
||||||
use anyhow::Result;
|
use anyhow::Result;
|
||||||
use log::trace;
|
|
||||||
use ratatui::crossterm::event::{Event, KeyEvent, MouseEvent};
|
use ratatui::crossterm::event::{Event, KeyEvent, MouseEvent};
|
||||||
use ratatui::style::Color;
|
|
||||||
|
|
||||||
pub enum Action {
|
pub enum Action {
|
||||||
/// Exit the application.
|
/// Exit the application.
|
||||||
@@ -23,15 +19,13 @@ pub enum Action {
|
|||||||
|
|
||||||
/// The input was handled by a Component and should not be passed to the next component.
|
/// The input was handled by a Component and should not be passed to the next component.
|
||||||
Handled,
|
Handled,
|
||||||
OpenTab,
|
|
||||||
ReloadFile,
|
|
||||||
ShowHideExplorer,
|
|
||||||
ShowHideLogger,
|
|
||||||
ShowHideAbout,
|
|
||||||
CloseTab,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait Component {
|
pub trait Component {
|
||||||
|
/// Returns a unique identifier for the component.
|
||||||
|
/// This is used for lookup in a container of Components.
|
||||||
|
fn id(&self) -> &str;
|
||||||
|
|
||||||
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
||||||
match event {
|
match event {
|
||||||
Event::Key(key_event) => self.handle_key_events(key_event),
|
Event::Key(key_event) => self.handle_key_events(key_event),
|
||||||
@@ -50,118 +44,4 @@ pub trait Component {
|
|||||||
fn update(&mut self, action: Action) -> Result<Action> {
|
fn update(&mut self, action: Action) -> Result<Action> {
|
||||||
Ok(Action::Noop)
|
Ok(Action::Noop)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Override this method for creating components that conditionally handle input.
|
|
||||||
fn is_active(&self) -> bool {
|
|
||||||
true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Default)]
|
|
||||||
pub struct ComponentState {
|
|
||||||
pub(crate) focus: Focus,
|
|
||||||
pub(crate) vis: Visibility,
|
|
||||||
pub(crate) help_text: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ComponentState {
|
|
||||||
pub fn id() -> &'static str {
|
|
||||||
"ComponentState"
|
|
||||||
}
|
|
||||||
|
|
||||||
fn new() -> Self {
|
|
||||||
trace!(target:Self::id(), "Building {}", Self::id());
|
|
||||||
Self {
|
|
||||||
focus: Active,
|
|
||||||
vis: Visibility::Visible,
|
|
||||||
help_text: String::new(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn with_help_text(mut self, help_text: &str) -> Self {
|
|
||||||
self.help_text = help_text.into();
|
|
||||||
self
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, Default, PartialEq)]
|
|
||||||
pub enum Focus {
|
|
||||||
Active,
|
|
||||||
#[default]
|
|
||||||
Inactive,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Focus {
|
|
||||||
pub(crate) fn get_active_color(&self) -> Color {
|
|
||||||
match self {
|
|
||||||
Active => Color::LightYellow,
|
|
||||||
Inactive => Color::White,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub trait FocusState {
|
|
||||||
fn with_focus(self, focus: Focus) -> Self;
|
|
||||||
fn set_focus(&mut self, focus: Focus);
|
|
||||||
fn toggle_focus(&mut self);
|
|
||||||
fn get_active_color(&self) -> Color;
|
|
||||||
}
|
|
||||||
|
|
||||||
impl FocusState for ComponentState {
|
|
||||||
fn with_focus(self, focus: Focus) -> Self {
|
|
||||||
Self {
|
|
||||||
focus,
|
|
||||||
vis: self.vis,
|
|
||||||
help_text: self.help_text,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_focus(&mut self, focus: Focus) {
|
|
||||||
self.focus = focus;
|
|
||||||
}
|
|
||||||
|
|
||||||
fn toggle_focus(&mut self) {
|
|
||||||
match self.focus {
|
|
||||||
Active => self.set_focus(Inactive),
|
|
||||||
Inactive => self.set_focus(Active),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn get_active_color(&self) -> Color {
|
|
||||||
self.focus.get_active_color()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Default, Copy, Clone, PartialEq, Eq)]
|
|
||||||
pub enum Visibility {
|
|
||||||
#[default]
|
|
||||||
Visible,
|
|
||||||
Hidden,
|
|
||||||
}
|
|
||||||
|
|
||||||
pub trait VisibleState {
|
|
||||||
fn with_visible(self, vis: Visibility) -> Self;
|
|
||||||
fn set_visible(&mut self, vis: Visibility);
|
|
||||||
fn toggle_visible(&mut self);
|
|
||||||
}
|
|
||||||
|
|
||||||
impl VisibleState for ComponentState {
|
|
||||||
fn with_visible(self, vis: Visibility) -> Self {
|
|
||||||
Self {
|
|
||||||
focus: self.focus,
|
|
||||||
vis,
|
|
||||||
help_text: self.help_text,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_visible(&mut self, vis: Visibility) {
|
|
||||||
self.vis = vis;
|
|
||||||
}
|
|
||||||
|
|
||||||
fn toggle_visible(&mut self) {
|
|
||||||
match self.vis {
|
|
||||||
Visibility::Visible => self.set_visible(Visibility::Hidden),
|
|
||||||
Visibility::Hidden => self.set_visible(Visibility::Visible),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,74 +1,53 @@
|
|||||||
use crate::tui::component::{Action, Component, ComponentState, Focus, FocusState};
|
use crate::tui::component::{Action, Component};
|
||||||
|
|
||||||
use anyhow::{Context, Result, bail};
|
use anyhow::{Context, Result, bail};
|
||||||
use edtui::{
|
use edtui::{
|
||||||
EditorEventHandler, EditorState, EditorTheme, EditorView, LineNumbers, Lines, SyntaxHighlighter,
|
EditorEventHandler, EditorState, EditorTheme, EditorView, LineNumbers, Lines, SyntaxHighlighter,
|
||||||
};
|
};
|
||||||
use log::{error, trace};
|
|
||||||
use ratatui::buffer::Buffer;
|
use ratatui::buffer::Buffer;
|
||||||
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent, KeyModifiers};
|
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent, KeyModifiers};
|
||||||
use ratatui::layout::{Alignment, Rect};
|
use ratatui::layout::{Alignment, Rect};
|
||||||
use ratatui::prelude::{Color, Style};
|
use ratatui::prelude::{Color, Style};
|
||||||
use ratatui::widgets::{Block, Borders, Padding, Widget};
|
use ratatui::widgets::{Block, Borders, Padding, Widget};
|
||||||
use std::path::PathBuf;
|
|
||||||
use syntect::parsing::SyntaxSet;
|
use syntect::parsing::SyntaxSet;
|
||||||
|
|
||||||
|
// TODO: Consider using editor-command https://docs.rs/editor-command/latest/editor_command/
|
||||||
|
// TODO: Title should be detected programming language name
|
||||||
|
// TODO: Content should be file contents
|
||||||
|
// TODO: Vimrc should be used
|
||||||
pub struct Editor {
|
pub struct Editor {
|
||||||
pub state: EditorState,
|
pub state: EditorState,
|
||||||
pub event_handler: EditorEventHandler,
|
pub event_handler: EditorEventHandler,
|
||||||
pub file_path: Option<std::path::PathBuf>,
|
pub file_path: Option<std::path::PathBuf>,
|
||||||
syntax_set: SyntaxSet,
|
syntax_set: SyntaxSet,
|
||||||
pub(crate) component_state: ComponentState,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Editor {
|
impl Editor {
|
||||||
pub const ID: &str = "Editor";
|
pub fn new() -> Self {
|
||||||
|
|
||||||
pub fn new(path: &std::path::Path) -> Self {
|
|
||||||
trace!(target:Self::ID, "Building {}", Self::ID);
|
|
||||||
Editor {
|
Editor {
|
||||||
state: EditorState::default(),
|
state: EditorState::default(),
|
||||||
event_handler: EditorEventHandler::default(),
|
event_handler: EditorEventHandler::default(),
|
||||||
file_path: Some(path.to_owned()),
|
file_path: None,
|
||||||
syntax_set: SyntaxSet::load_defaults_nonewlines(),
|
syntax_set: SyntaxSet::load_defaults_nonewlines(),
|
||||||
component_state: ComponentState::default().with_help_text(concat!(
|
|
||||||
"CTRL+S: Save file | ALT+(←/h): Previous tab | ALT+(l/→): Next tab |",
|
|
||||||
" All other input is handled by vim"
|
|
||||||
)),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn reload_contents(&mut self) -> Result<()> {
|
pub fn set_contents(&mut self, path: &std::path::PathBuf) -> Result<()> {
|
||||||
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");
|
|
||||||
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::Path) -> Result<()> {
|
|
||||||
trace!(target:Self::ID, "Setting Editor contents from path {:?}", path);
|
|
||||||
if let Ok(contents) = std::fs::read_to_string(path) {
|
if let Ok(contents) = std::fs::read_to_string(path) {
|
||||||
let lines: Vec<_> = contents
|
let lines: Vec<_> = contents
|
||||||
.lines()
|
.lines()
|
||||||
.map(|line| line.chars().collect::<Vec<char>>())
|
.map(|line| line.chars().collect::<Vec<char>>())
|
||||||
.collect();
|
.collect();
|
||||||
self.file_path = Some(PathBuf::from(path));
|
self.file_path = Some(path.clone());
|
||||||
self.state.lines = Lines::new(lines);
|
self.state.lines = Lines::new(lines);
|
||||||
self.state.cursor.row = 0;
|
|
||||||
self.state.cursor.col = 0;
|
|
||||||
}
|
}
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn save(&self) -> Result<()> {
|
pub fn save(&self) -> Result<()> {
|
||||||
if let Some(path) = &self.file_path {
|
if let Some(path) = &self.file_path {
|
||||||
trace!(target:Self::ID, "Saving Editor contents {:?}", path);
|
|
||||||
return std::fs::write(path, self.state.lines.to_string()).map_err(|e| e.into());
|
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");
|
|
||||||
bail!("File not saved. No file path set.")
|
bail!("File not saved. No file path set.")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -85,7 +64,7 @@ impl Widget for &mut Editor {
|
|||||||
.syntax_set
|
.syntax_set
|
||||||
.find_syntax_by_extension(lang)
|
.find_syntax_by_extension(lang)
|
||||||
.map(|s| s.name.to_string())
|
.map(|s| s.name.to_string())
|
||||||
.unwrap_or_else(|| String::from("Unknown"));
|
.unwrap_or("Unknown".to_string());
|
||||||
|
|
||||||
EditorView::new(&mut self.state)
|
EditorView::new(&mut self.state)
|
||||||
.wrap(true)
|
.wrap(true)
|
||||||
@@ -96,8 +75,7 @@ impl Widget for &mut Editor {
|
|||||||
.title_style(Style::default().fg(Color::Yellow))
|
.title_style(Style::default().fg(Color::Yellow))
|
||||||
.title_alignment(Alignment::Right)
|
.title_alignment(Alignment::Right)
|
||||||
.borders(Borders::ALL)
|
.borders(Borders::ALL)
|
||||||
.padding(Padding::new(0, 0, 0, 1))
|
.padding(Padding::new(0, 0, 0, 1)),
|
||||||
.style(Style::default().fg(self.component_state.get_active_color())),
|
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
.syntax_highlighter(SyntaxHighlighter::new("dracula", lang).ok())
|
.syntax_highlighter(SyntaxHighlighter::new("dracula", lang).ok())
|
||||||
@@ -108,6 +86,10 @@ impl Widget for &mut Editor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl Component for Editor {
|
impl Component for Editor {
|
||||||
|
fn id(&self) -> &str {
|
||||||
|
"Editor"
|
||||||
|
}
|
||||||
|
|
||||||
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
||||||
if let Some(key_event) = event.as_key_event() {
|
if let Some(key_event) = event.as_key_event() {
|
||||||
// Handle events here that should not be passed on to the vim emulation handler.
|
// Handle events here that should not be passed on to the vim emulation handler.
|
||||||
@@ -136,8 +118,4 @@ impl Component for Editor {
|
|||||||
_ => Ok(Action::Noop),
|
_ => Ok(Action::Noop),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn is_active(&self) -> bool {
|
|
||||||
self.component_state.focus == Focus::Active
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,233 +0,0 @@
|
|||||||
use crate::tui::component::{Action, Component, Focus, FocusState};
|
|
||||||
use crate::tui::editor::Editor;
|
|
||||||
use anyhow::{Context, Result, anyhow};
|
|
||||||
use log::{error, info, trace, warn};
|
|
||||||
use ratatui::buffer::Buffer;
|
|
||||||
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent, KeyModifiers};
|
|
||||||
use ratatui::layout::Rect;
|
|
||||||
use ratatui::prelude::{Color, Style};
|
|
||||||
use ratatui::widgets::{Block, Borders, Padding, Tabs, Widget};
|
|
||||||
use std::collections::HashMap;
|
|
||||||
|
|
||||||
// Render the tabs with keys as titles
|
|
||||||
// Tab keys can be file names.
|
|
||||||
// Render the editor using the key as a reference for lookup
|
|
||||||
pub struct EditorTab {
|
|
||||||
pub(crate) editors: HashMap<String, Editor>,
|
|
||||||
tab_order: Vec<String>,
|
|
||||||
current_editor: usize,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl EditorTab {
|
|
||||||
pub const ID: &str = "EditorTab";
|
|
||||||
|
|
||||||
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);
|
|
||||||
self.set_tab_focus(Focus::Active, next);
|
|
||||||
self.current_editor = next;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn prev_editor(&mut self) {
|
|
||||||
let prev = self
|
|
||||||
.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);
|
|
||||||
self.set_tab_focus(Focus::Active, prev);
|
|
||||||
self.current_editor = prev;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn get_editor_key(&self, index: usize) -> Option<String> {
|
|
||||||
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}");
|
|
||||||
}
|
|
||||||
None
|
|
||||||
}
|
|
||||||
Some(key) => Some(key.to_owned()),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn current_editor(&self) -> Option<&Editor> {
|
|
||||||
self.editors.get(&self.get_editor_key(self.current_editor)?)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn current_editor_mut(&mut self) -> Option<&mut Editor> {
|
|
||||||
self.editors
|
|
||||||
.get_mut(&self.get_editor_key(self.current_editor)?)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_current_tab_focus(&mut self, focus: 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);
|
|
||||||
if focus == Focus::Active && index != self.current_editor {
|
|
||||||
// If we are setting another tab to active, disable the current one.
|
|
||||||
trace!(
|
|
||||||
target:Self::ID,
|
|
||||||
"New tab {} focus set to Active; Setting current tab {} to Inactive",
|
|
||||||
index,
|
|
||||||
self.current_editor
|
|
||||||
);
|
|
||||||
self.set_current_tab_focus(Focus::Inactive);
|
|
||||||
}
|
|
||||||
match self.get_editor_key(index) {
|
|
||||||
None => {
|
|
||||||
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,
|
|
||||||
"Failed to update tab focus at index {} with invalid key: {}",
|
|
||||||
self.current_editor,
|
|
||||||
self.tab_order[self.current_editor]
|
|
||||||
)
|
|
||||||
}
|
|
||||||
Some(editor) => editor.component_state.set_focus(focus),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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");
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
|
|
||||||
let path_str = path.to_string_lossy().to_string();
|
|
||||||
self.tab_order.push(path_str.clone());
|
|
||||||
let mut editor = Editor::new(path);
|
|
||||||
editor.set_contents(path).context("Failed to open tab")?;
|
|
||||||
self.editors.insert(path_str, editor);
|
|
||||||
self.current_editor = self.tab_order.len() - 1;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn close_current_tab(&mut self) -> Result<()> {
|
|
||||||
self.close_tab(self.current_editor)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn close_tab(&mut self, index: usize) -> Result<()> {
|
|
||||||
let key = self
|
|
||||||
.tab_order
|
|
||||||
.get(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}")
|
|
||||||
}
|
|
||||||
Some(_) => {
|
|
||||||
self.prev_editor();
|
|
||||||
self.tab_order.remove(index);
|
|
||||||
info!(target:Self::ID, "Closed editor tab {key} at index {index}")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn is_empty(&self) -> bool {
|
|
||||||
self.editors.is_empty()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn render(&mut self, tabs_area: Rect, editor_area: Rect, buf: &mut Buffer) {
|
|
||||||
// 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::Path::new(t)
|
|
||||||
.file_name()
|
|
||||||
.map(|f| f.to_string_lossy().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)
|
|
||||||
.select(self.current_editor)
|
|
||||||
.divider("|")
|
|
||||||
.block(
|
|
||||||
Block::default()
|
|
||||||
.borders(Borders::NONE)
|
|
||||||
.padding(Padding::new(0, 0, 0, 0)),
|
|
||||||
)
|
|
||||||
.highlight_style(Style::default().fg(Color::LightRed))
|
|
||||||
.render(tabs_area, buf);
|
|
||||||
Widget::render(self, editor_area, buf);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Widget for &mut EditorTab {
|
|
||||||
fn render(self, area: Rect, buf: &mut Buffer)
|
|
||||||
where
|
|
||||||
Self: Sized,
|
|
||||||
{
|
|
||||||
if let Some(editor) = self.current_editor_mut() {
|
|
||||||
editor.render(area, buf);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Component for EditorTab {
|
|
||||||
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
|
||||||
if let Some(key) = event.as_key_event() {
|
|
||||||
let action = self.handle_key_events(key)?;
|
|
||||||
match action {
|
|
||||||
Action::Quit | Action::Handled => return Ok(action),
|
|
||||||
_ => {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if let Some(editor) = self.current_editor_mut() {
|
|
||||||
return editor.handle_event(event);
|
|
||||||
}
|
|
||||||
Ok(Action::Noop)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn handle_key_events(&mut self, key: KeyEvent) -> Result<Action> {
|
|
||||||
match key {
|
|
||||||
KeyEvent {
|
|
||||||
code: KeyCode::Char('h'),
|
|
||||||
modifiers: KeyModifiers::ALT,
|
|
||||||
..
|
|
||||||
}
|
|
||||||
| KeyEvent {
|
|
||||||
code: KeyCode::Left,
|
|
||||||
modifiers: KeyModifiers::ALT,
|
|
||||||
..
|
|
||||||
} => {
|
|
||||||
self.prev_editor();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
KeyEvent {
|
|
||||||
code: KeyCode::Char('l'),
|
|
||||||
modifiers: KeyModifiers::ALT,
|
|
||||||
..
|
|
||||||
}
|
|
||||||
| KeyEvent {
|
|
||||||
code: KeyCode::Right,
|
|
||||||
modifiers: KeyModifiers::ALT,
|
|
||||||
..
|
|
||||||
} => {
|
|
||||||
self.next_editor();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
_ => Ok(Action::Noop),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,62 +1,50 @@
|
|||||||
use crate::tui::component::{Action, Component, ComponentState, Focus, FocusState};
|
use crate::tui::component::{Action, Component};
|
||||||
use anyhow::{Context, Result, bail};
|
use anyhow::{Context, Result, bail};
|
||||||
use log::trace;
|
|
||||||
use ratatui::buffer::Buffer;
|
use ratatui::buffer::Buffer;
|
||||||
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent, MouseEvent, MouseEventKind};
|
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent, MouseEvent, MouseEventKind};
|
||||||
use ratatui::layout::{Alignment, Position, Rect};
|
use ratatui::layout::{Alignment, Position, Rect};
|
||||||
use ratatui::prelude::Style;
|
use ratatui::prelude::Style;
|
||||||
use ratatui::style::{Color, Modifier};
|
use ratatui::style::{Color, Modifier};
|
||||||
use ratatui::widgets::{Block, Borders, StatefulWidget, Widget};
|
use ratatui::widgets::{Block, Borders, StatefulWidget};
|
||||||
use std::ffi::OsStr;
|
|
||||||
use std::fs;
|
use std::fs;
|
||||||
use std::path::{Path, PathBuf};
|
|
||||||
use tui_tree_widget::{Tree, TreeItem, TreeState};
|
use tui_tree_widget::{Tree, TreeItem, TreeState};
|
||||||
|
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
pub struct Explorer<'a> {
|
pub struct Explorer<'a> {
|
||||||
pub(crate) root_path: PathBuf,
|
root_path: std::path::PathBuf,
|
||||||
tree_items: TreeItem<'a, String>,
|
tree_items: TreeItem<'a, String>,
|
||||||
tree_state: TreeState<String>,
|
tree_state: TreeState<String>,
|
||||||
pub(crate) component_state: ComponentState,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> Explorer<'a> {
|
impl<'a> Explorer<'a> {
|
||||||
pub const ID: &'static str = "Explorer";
|
pub fn new(path: &std::path::PathBuf) -> Result<Self> {
|
||||||
|
|
||||||
pub fn new(path: &PathBuf) -> Result<Self> {
|
|
||||||
trace!(target:Self::ID, "Building {}", Self::ID);
|
|
||||||
let explorer = Explorer {
|
let explorer = Explorer {
|
||||||
root_path: path.to_owned(),
|
root_path: path.to_owned(),
|
||||||
tree_items: Self::build_tree_from_path(path.to_owned())?,
|
tree_items: Self::build_tree_from_path(path.to_owned())?,
|
||||||
tree_state: TreeState::default(),
|
tree_state: TreeState::default(),
|
||||||
component_state: ComponentState::default().with_help_text(concat!(
|
|
||||||
"(↑/k)/(↓/j): Select item | ←/h: Close folder | →/l: Open folder |",
|
|
||||||
" Space: Open / close folder | Enter: Open file in new editor tab"
|
|
||||||
)),
|
|
||||||
};
|
};
|
||||||
Ok(explorer)
|
Ok(explorer)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn build_tree_from_path(path: PathBuf) -> Result<TreeItem<'static, String>> {
|
fn build_tree_from_path(path: std::path::PathBuf) -> Result<TreeItem<'static, String>> {
|
||||||
let mut children = vec![];
|
let mut children = vec![];
|
||||||
let clean_path = fs::canonicalize(path)?;
|
if let Ok(entries) = fs::read_dir(&path) {
|
||||||
if let Ok(entries) = fs::read_dir(&clean_path) {
|
|
||||||
let mut paths = entries
|
let mut paths = entries
|
||||||
.map(|res| res.map(|e| e.path()))
|
.map(|res| res.map(|e| e.path()))
|
||||||
.collect::<Result<Vec<_>, std::io::Error>>()
|
.collect::<Result<Vec<_>, std::io::Error>>()
|
||||||
.context(format!(
|
.context(format!(
|
||||||
"Failed to build vector of paths under directory: {:?}",
|
"Failed to build vector of paths under directory: {:?}",
|
||||||
clean_path
|
path
|
||||||
))?;
|
))?;
|
||||||
paths.sort();
|
paths.sort();
|
||||||
for path in paths {
|
for path in paths {
|
||||||
if path.is_dir() {
|
if path.is_dir() {
|
||||||
children.push(Self::build_tree_from_path(path)?);
|
children.push(Self::build_tree_from_path(path)?);
|
||||||
} else {
|
} else {
|
||||||
if let Ok(path) = fs::canonicalize(&path) {
|
if let Ok(path) = std::path::absolute(&path) {
|
||||||
let path_str = path.to_string_lossy().to_string();
|
let path_str = path.to_string_lossy().to_string();
|
||||||
children.push(TreeItem::new_leaf(
|
children.push(TreeItem::new_leaf(
|
||||||
path_str + uuid::Uuid::new_v4().to_string().as_str(),
|
path_str,
|
||||||
path.file_name()
|
path.file_name()
|
||||||
.context("Failed to get file name from path.")?
|
.context("Failed to get file name from path.")?
|
||||||
.to_string_lossy()
|
.to_string_lossy()
|
||||||
@@ -67,42 +55,38 @@ 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(
|
TreeItem::new(
|
||||||
clean_path.to_string_lossy().to_string() + uuid::Uuid::new_v4().to_string().as_str(),
|
abs,
|
||||||
clean_path
|
path.file_name()
|
||||||
.file_name()
|
.expect("Failed to get file name from path.")
|
||||||
.context(format!("Failed to get file name from path: {clean_path:?}"))?
|
|
||||||
.to_string_lossy()
|
.to_string_lossy()
|
||||||
.to_string(),
|
.to_string(),
|
||||||
children,
|
children,
|
||||||
)
|
)
|
||||||
.context(format!("Failed to build tree from path: {clean_path:?}"))
|
.context("Failed to build tree from path.")
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn selected(&self) -> Result<String> {
|
pub fn render(&mut self, area: Rect, buf: &mut Buffer) -> Result<()> {
|
||||||
if let Some(path) = self.tree_state.selected().last() {
|
StatefulWidget::render(
|
||||||
return Ok(std::path::absolute(path)?
|
Tree::new(&self.tree_items.children())
|
||||||
.to_str()
|
.context("Failed to build file Explorer Tree.")?
|
||||||
.context("Failed to get absolute path to selected TreeItem")?
|
.style(Style::default())
|
||||||
.to_string());
|
.block(
|
||||||
}
|
|
||||||
bail!("Failed to get selected TreeItem")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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_else(|| OsStr::new("Unknown"));
|
|
||||||
StatefulWidget::render(
|
|
||||||
tree.block(
|
|
||||||
Block::default()
|
Block::default()
|
||||||
.borders(Borders::ALL)
|
.borders(Borders::ALL)
|
||||||
.title(file_name.to_string_lossy())
|
.title(
|
||||||
.border_style(Style::default().fg(self.component_state.get_active_color()))
|
self.root_path
|
||||||
|
.file_name()
|
||||||
|
.context("Failed to get file name from path.")?
|
||||||
|
.to_string_lossy(),
|
||||||
|
)
|
||||||
.title_style(Style::default().fg(Color::Green))
|
.title_style(Style::default().fg(Color::Green))
|
||||||
.title_alignment(Alignment::Center),
|
.title_alignment(Alignment::Center),
|
||||||
)
|
)
|
||||||
@@ -112,21 +96,30 @@ impl<'a> Widget for &mut Explorer<'a> {
|
|||||||
.bg(Color::Rgb(57, 59, 64))
|
.bg(Color::Rgb(57, 59, 64))
|
||||||
.add_modifier(Modifier::BOLD),
|
.add_modifier(Modifier::BOLD),
|
||||||
),
|
),
|
||||||
area,
|
area,
|
||||||
buf,
|
buf,
|
||||||
&mut self.tree_state,
|
&mut self.tree_state,
|
||||||
);
|
);
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn selected(&self) -> Result<String> {
|
||||||
|
if let Some(path) = self.tree_state.selected().last() {
|
||||||
|
return Ok(std::path::absolute(path)?.to_str().unwrap().to_string());
|
||||||
}
|
}
|
||||||
|
bail!("Failed to get selected TreeItem")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> Component for Explorer<'a> {
|
impl<'a> Component for Explorer<'a> {
|
||||||
|
fn id(&self) -> &str {
|
||||||
|
"Explorer"
|
||||||
|
}
|
||||||
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
||||||
if let Some(key_event) = event.as_key_event() {
|
if let Some(key_event) = event.as_key_event() {
|
||||||
// Handle events here that should not be passed on to the vim emulation handler.
|
// Handle events here that should not be passed on to the vim emulation handler.
|
||||||
match self.handle_key_events(key_event)? {
|
match self.handle_key_events(key_event)? {
|
||||||
Action::Handled => return Ok(Action::Handled),
|
Action::Handled => return Ok(Action::Handled),
|
||||||
Action::OpenTab => return Ok(Action::OpenTab),
|
|
||||||
_ => {}
|
_ => {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -140,27 +133,16 @@ impl<'a> Component for Explorer<'a> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn handle_key_events(&mut self, key: KeyEvent) -> Result<Action> {
|
fn handle_key_events(&mut self, key: KeyEvent) -> Result<Action> {
|
||||||
if key.code == KeyCode::Enter {
|
|
||||||
if let Ok(selected) = self.selected() {
|
|
||||||
if Path::new(&selected).is_file() {
|
|
||||||
return Ok(Action::OpenTab);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Otherwise fall through and handle Enter in the next match case.
|
|
||||||
}
|
|
||||||
|
|
||||||
let changed = match key.code {
|
let changed = match key.code {
|
||||||
KeyCode::Up | KeyCode::Char('k') => self.tree_state.key_up(),
|
KeyCode::Up => self.tree_state.key_up(),
|
||||||
KeyCode::Down | KeyCode::Char('j') => self.tree_state.key_down(),
|
KeyCode::Char('k') => self.tree_state.key_up(),
|
||||||
KeyCode::Left | KeyCode::Char('h') => {
|
KeyCode::Down => self.tree_state.key_down(),
|
||||||
// Do not call key_left(); Calling it on a closed folder clears the selection.
|
KeyCode::Char('j') => self.tree_state.key_down(),
|
||||||
let key = self.tree_state.selected().to_owned();
|
KeyCode::Left => self.tree_state.key_left(),
|
||||||
self.tree_state.close(key.as_ref())
|
KeyCode::Char('h') => self.tree_state.key_left(),
|
||||||
}
|
KeyCode::Right => self.tree_state.key_right(),
|
||||||
KeyCode::Char(' ') | KeyCode::Enter => self
|
KeyCode::Char('l') => self.tree_state.key_right(),
|
||||||
.tree_state
|
KeyCode::Enter => self.tree_state.toggle_selected(),
|
||||||
.toggle(self.tree_state.selected().to_owned()),
|
|
||||||
KeyCode::Right | KeyCode::Char('l') => self.tree_state.key_right(),
|
|
||||||
_ => false,
|
_ => false,
|
||||||
};
|
};
|
||||||
if changed {
|
if changed {
|
||||||
@@ -183,8 +165,4 @@ impl<'a> Component for Explorer<'a> {
|
|||||||
}
|
}
|
||||||
Ok(Action::Noop)
|
Ok(Action::Noop)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn is_active(&self) -> bool {
|
|
||||||
self.component_state.focus == Focus::Active
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
use crate::tui::component::{Action, Component, ComponentState, Focus, FocusState};
|
use crate::tui::component::{Action, Component};
|
||||||
use log::{LevelFilter, trace};
|
|
||||||
use ratatui::buffer::Buffer;
|
use ratatui::buffer::Buffer;
|
||||||
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent};
|
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent};
|
||||||
use ratatui::layout::Rect;
|
use ratatui::layout::Rect;
|
||||||
@@ -11,25 +10,12 @@ use tui_logger::{TuiLoggerLevelOutput, TuiLoggerSmartWidget, TuiWidgetEvent, Tui
|
|||||||
/// The logger is bound to info!, debug!, error!, trace! macros within Tui::new().
|
/// The logger is bound to info!, debug!, error!, trace! macros within Tui::new().
|
||||||
pub struct Logger {
|
pub struct Logger {
|
||||||
state: TuiWidgetState,
|
state: TuiWidgetState,
|
||||||
pub(crate) component_state: ComponentState,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Logger {
|
impl Logger {
|
||||||
pub const ID: &str = "Logger";
|
|
||||||
|
|
||||||
pub fn new() -> Self {
|
pub fn new() -> Self {
|
||||||
trace!(target:Self::ID, "Building {}", Self::ID);
|
|
||||||
let state = TuiWidgetState::new();
|
|
||||||
state.transition(TuiWidgetEvent::HideKey);
|
|
||||||
Self {
|
Self {
|
||||||
state: state
|
state: TuiWidgetState::new(),
|
||||||
.set_level_for_target("arboard::platform::linux::x11", LevelFilter::Off)
|
|
||||||
.set_level_for_target("mio::poll", LevelFilter::Off),
|
|
||||||
component_state: ComponentState::default().with_help_text(concat!(
|
|
||||||
"Space: Hide/show logging target selector panel | (↑/k)/(↓/j): Select target |",
|
|
||||||
" (←/h)/(→/l): Display level | f: Focus target | +/-: Filter level |",
|
|
||||||
" v: Toggle filtered targets visibility | PageUp/Down: Scroll | Esc: Cancel scroll"
|
|
||||||
)),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -39,8 +25,8 @@ impl Widget for &Logger {
|
|||||||
where
|
where
|
||||||
Self: Sized,
|
Self: Sized,
|
||||||
{
|
{
|
||||||
|
// TODO: Use output_file?
|
||||||
TuiLoggerSmartWidget::default()
|
TuiLoggerSmartWidget::default()
|
||||||
.border_style(Style::default().fg(self.component_state.get_active_color()))
|
|
||||||
.style_error(Style::default().fg(Color::Red))
|
.style_error(Style::default().fg(Color::Red))
|
||||||
.style_debug(Style::default().fg(Color::Green))
|
.style_debug(Style::default().fg(Color::Green))
|
||||||
.style_warn(Style::default().fg(Color::Yellow))
|
.style_warn(Style::default().fg(Color::Yellow))
|
||||||
@@ -58,6 +44,10 @@ impl Widget for &Logger {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl Component for Logger {
|
impl Component for Logger {
|
||||||
|
fn id(&self) -> &str {
|
||||||
|
"Logger"
|
||||||
|
}
|
||||||
|
|
||||||
fn handle_event(&mut self, event: Event) -> anyhow::Result<Action> {
|
fn handle_event(&mut self, event: Event) -> anyhow::Result<Action> {
|
||||||
if let Some(key_event) = event.as_key_event() {
|
if let Some(key_event) = event.as_key_event() {
|
||||||
return self.handle_key_events(key_event);
|
return self.handle_key_events(key_event);
|
||||||
@@ -67,24 +57,20 @@ impl Component for Logger {
|
|||||||
|
|
||||||
fn handle_key_events(&mut self, key: KeyEvent) -> anyhow::Result<Action> {
|
fn handle_key_events(&mut self, key: KeyEvent) -> anyhow::Result<Action> {
|
||||||
match key.code {
|
match key.code {
|
||||||
KeyCode::Char('v') => self.state.transition(TuiWidgetEvent::SpaceKey),
|
KeyCode::Char(' ') => self.state.transition(TuiWidgetEvent::SpaceKey),
|
||||||
KeyCode::Esc => self.state.transition(TuiWidgetEvent::EscapeKey),
|
KeyCode::Esc => self.state.transition(TuiWidgetEvent::EscapeKey),
|
||||||
KeyCode::PageUp => self.state.transition(TuiWidgetEvent::PrevPageKey),
|
KeyCode::PageUp => self.state.transition(TuiWidgetEvent::PrevPageKey),
|
||||||
KeyCode::PageDown => self.state.transition(TuiWidgetEvent::NextPageKey),
|
KeyCode::PageDown => self.state.transition(TuiWidgetEvent::NextPageKey),
|
||||||
KeyCode::Up | KeyCode::Char('k') => self.state.transition(TuiWidgetEvent::UpKey),
|
KeyCode::Up => self.state.transition(TuiWidgetEvent::UpKey),
|
||||||
KeyCode::Down | KeyCode::Char('j') => self.state.transition(TuiWidgetEvent::DownKey),
|
KeyCode::Down => self.state.transition(TuiWidgetEvent::DownKey),
|
||||||
KeyCode::Left | KeyCode::Char('h') => self.state.transition(TuiWidgetEvent::LeftKey),
|
KeyCode::Left => self.state.transition(TuiWidgetEvent::LeftKey),
|
||||||
KeyCode::Right | KeyCode::Char('l') => self.state.transition(TuiWidgetEvent::RightKey),
|
KeyCode::Right => self.state.transition(TuiWidgetEvent::RightKey),
|
||||||
KeyCode::Char('+') => self.state.transition(TuiWidgetEvent::PlusKey),
|
KeyCode::Char('+') => self.state.transition(TuiWidgetEvent::PlusKey),
|
||||||
KeyCode::Char('-') => self.state.transition(TuiWidgetEvent::MinusKey),
|
KeyCode::Char('-') => self.state.transition(TuiWidgetEvent::MinusKey),
|
||||||
KeyCode::Char(' ') => self.state.transition(TuiWidgetEvent::HideKey),
|
KeyCode::Char('h') => self.state.transition(TuiWidgetEvent::HideKey),
|
||||||
KeyCode::Char('f') => self.state.transition(TuiWidgetEvent::FocusKey),
|
KeyCode::Char('f') => self.state.transition(TuiWidgetEvent::FocusKey),
|
||||||
_ => (),
|
_ => (),
|
||||||
}
|
}
|
||||||
Ok(Action::Pass)
|
Ok(Action::Pass)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn is_active(&self) -> bool {
|
|
||||||
self.component_state.focus == Focus::Active
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,243 +0,0 @@
|
|||||||
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};
|
|
||||||
use ratatui::layout::Rect;
|
|
||||||
use ratatui::style::{Color, Modifier, Style};
|
|
||||||
use ratatui::text::Line;
|
|
||||||
use ratatui::widgets::{
|
|
||||||
Block, Borders, Clear, List, ListItem, ListState, StatefulWidget, Tabs, Widget,
|
|
||||||
};
|
|
||||||
use strum::{EnumIter, FromRepr, IntoEnumIterator};
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, FromRepr, EnumIter)]
|
|
||||||
enum MenuBarItem {
|
|
||||||
File,
|
|
||||||
View,
|
|
||||||
Help,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, FromRepr, EnumIter)]
|
|
||||||
enum MenuBarItemOption {
|
|
||||||
Save,
|
|
||||||
CloseTab,
|
|
||||||
Reload,
|
|
||||||
Exit,
|
|
||||||
ShowHideExplorer,
|
|
||||||
ShowHideLogger,
|
|
||||||
About,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl MenuBarItemOption {
|
|
||||||
fn id(&self) -> &str {
|
|
||||||
match self {
|
|
||||||
Save => "Save",
|
|
||||||
Reload => "Reload",
|
|
||||||
Exit => "Exit",
|
|
||||||
ShowHideExplorer => "Show / hide explorer",
|
|
||||||
ShowHideLogger => "Show / hide logger",
|
|
||||||
About => "About",
|
|
||||||
CloseTab => "Close tab",
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl MenuBarItem {
|
|
||||||
pub fn next(self) -> Self {
|
|
||||||
let cur = self as usize;
|
|
||||||
let next = cur.saturating_add(1);
|
|
||||||
Self::from_repr(next).unwrap_or(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn prev(self) -> Self {
|
|
||||||
let cur = self as usize;
|
|
||||||
let prev = cur.saturating_sub(1);
|
|
||||||
Self::from_repr(prev).unwrap_or(self)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn id(&self) -> &str {
|
|
||||||
match self {
|
|
||||||
MenuBarItem::File => "File",
|
|
||||||
MenuBarItem::View => "View",
|
|
||||||
MenuBarItem::Help => "Help",
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn options(&self) -> &[MenuBarItemOption] {
|
|
||||||
match self {
|
|
||||||
MenuBarItem::File => &[Save, CloseTab, Reload, Exit],
|
|
||||||
MenuBarItem::View => &[ShowHideExplorer, ShowHideLogger],
|
|
||||||
MenuBarItem::Help => &[About],
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub struct MenuBar {
|
|
||||||
selected: MenuBarItem,
|
|
||||||
opened: Option<MenuBarItem>,
|
|
||||||
pub(crate) component_state: ComponentState,
|
|
||||||
list_state: ListState,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl 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);
|
|
||||||
Self {
|
|
||||||
selected: MenuBarItem::File,
|
|
||||||
opened: None,
|
|
||||||
component_state: ComponentState::default().with_help_text(Self::DEFAULT_HELP),
|
|
||||||
list_state: ListState::default().with_selected(Some(0)),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn render_title_bar(&self, area: Rect, buf: &mut Buffer) {
|
|
||||||
let titles: Vec<Line> = MenuBarItem::iter()
|
|
||||||
.map(|item| Line::from(item.id().to_owned()))
|
|
||||||
.collect();
|
|
||||||
let tabs_style = Style::default();
|
|
||||||
let highlight_style = if self.opened.is_some() {
|
|
||||||
Style::default().bg(Color::Blue).fg(Color::White)
|
|
||||||
} else {
|
|
||||||
Style::default().bg(Color::Cyan).fg(Color::Black)
|
|
||||||
};
|
|
||||||
Tabs::new(titles)
|
|
||||||
.style(tabs_style)
|
|
||||||
.block(
|
|
||||||
Block::default()
|
|
||||||
.borders(Borders::ALL)
|
|
||||||
.border_style(Style::default().fg(self.component_state.get_active_color())),
|
|
||||||
)
|
|
||||||
.highlight_style(highlight_style)
|
|
||||||
.select(self.selected as usize)
|
|
||||||
.render(area, buf);
|
|
||||||
}
|
|
||||||
|
|
||||||
fn render_drop_down(
|
|
||||||
&mut self,
|
|
||||||
title_bar_anchor: Rect,
|
|
||||||
area: Rect,
|
|
||||||
buf: &mut Buffer,
|
|
||||||
opened: MenuBarItem,
|
|
||||||
) {
|
|
||||||
let popup_area = Self::rect_under_option(title_bar_anchor, area, 27, 10);
|
|
||||||
Clear::default().render(popup_area, buf);
|
|
||||||
let options = opened.options().iter().map(|i| ListItem::new(i.id()));
|
|
||||||
StatefulWidget::render(
|
|
||||||
List::new(options)
|
|
||||||
.block(Block::bordered().title(self.selected.id()))
|
|
||||||
.highlight_style(
|
|
||||||
Style::default()
|
|
||||||
.bg(Color::Blue)
|
|
||||||
.fg(Color::White)
|
|
||||||
.add_modifier(Modifier::BOLD),
|
|
||||||
)
|
|
||||||
.highlight_symbol(">> "),
|
|
||||||
popup_area,
|
|
||||||
buf,
|
|
||||||
&mut self.list_state,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
fn rect_under_option(anchor: Rect, area: Rect, width: u16, height: u16) -> Rect {
|
|
||||||
let rect = Rect {
|
|
||||||
x: anchor.x,
|
|
||||||
y: anchor.y + anchor.height,
|
|
||||||
width: width.min(area.width),
|
|
||||||
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);
|
|
||||||
rect
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Widget for &mut MenuBar {
|
|
||||||
fn render(self, area: Rect, buf: &mut Buffer)
|
|
||||||
where
|
|
||||||
Self: Sized,
|
|
||||||
{
|
|
||||||
let title_bar_area = Rect {
|
|
||||||
x: area.x,
|
|
||||||
y: area.y,
|
|
||||||
width: area.width,
|
|
||||||
height: 3,
|
|
||||||
};
|
|
||||||
self.render_title_bar(title_bar_area, buf);
|
|
||||||
if let Some(opened) = self.opened {
|
|
||||||
self.render_drop_down(title_bar_area, area, buf, opened);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Component for MenuBar {
|
|
||||||
fn handle_key_events(&mut self, key: KeyEvent) -> anyhow::Result<Action> {
|
|
||||||
if self.opened.is_some() {
|
|
||||||
// Keybinds for popup menu.
|
|
||||||
match key.code {
|
|
||||||
KeyCode::Up | KeyCode::Char('k') => {
|
|
||||||
self.list_state.select_previous();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
KeyCode::Down | KeyCode::Char('j') => {
|
|
||||||
self.list_state.select_next();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
KeyCode::Enter => {
|
|
||||||
if let Some(selected) = self.list_state.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),
|
|
||||||
Reload => Ok(Action::ReloadFile),
|
|
||||||
ShowHideExplorer => Ok(Action::ShowHideExplorer),
|
|
||||||
ShowHideLogger => Ok(Action::ShowHideLogger),
|
|
||||||
About => Ok(Action::ShowHideAbout),
|
|
||||||
CloseTab => Ok(Action::CloseTab),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
Ok(Action::Noop)
|
|
||||||
}
|
|
||||||
KeyCode::Esc | KeyCode::Char('q') => {
|
|
||||||
self.opened = None;
|
|
||||||
self.component_state.help_text = Self::DEFAULT_HELP.to_string();
|
|
||||||
self.list_state.select_first();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
_ => Ok(Action::Noop),
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// Keybinds for title bar.
|
|
||||||
match key.code {
|
|
||||||
KeyCode::Left | KeyCode::Char('h') => {
|
|
||||||
self.selected = self.selected.prev();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
KeyCode::Right | KeyCode::Char('l') => {
|
|
||||||
self.selected = self.selected.next();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
KeyCode::Enter => {
|
|
||||||
self.opened = Some(self.selected);
|
|
||||||
self.component_state.help_text = concat!(
|
|
||||||
"(↑/k)/(↓/j): Select option | Enter: Choose selection |",
|
|
||||||
" ESC/Q: Close drop-down menu"
|
|
||||||
)
|
|
||||||
.to_string();
|
|
||||||
Ok(Action::Handled)
|
|
||||||
}
|
|
||||||
_ => Ok(Action::Noop),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user