Compare commits
22 Commits
ui
...
shared-mod
| Author | SHA1 | Date | |
|---|---|---|---|
| fed1d43ac9 | |||
| b0ed2e6e1f | |||
| 2e67c01377 | |||
| 5b356781ba | |||
| be969ef335 | |||
| c21ede292c | |||
| 11fd130171 | |||
| 65242c2ea9 | |||
| 73c467e19e | |||
| 8fd0bb48de | |||
| d5671a5590 | |||
| 7490e36a2f | |||
| 0e8910807e | |||
| 289f94300c | |||
| d95aa680ff | |||
| 1119b3db9b | |||
| 7ad25af13d | |||
| 7d4f23d82a | |||
| b4e14f7f27 | |||
| f6fdd19f73 | |||
| 2340fd7652 | |||
| 00f9075d0f |
2
.cargo/config.toml
Normal file
2
.cargo/config.toml
Normal file
@@ -0,0 +1,2 @@
|
||||
[build]
|
||||
rustflags = [ "-C", "link-arg=-fuse-ld=lld", ]
|
||||
20
.github/actions/setup-qt/action.yml
vendored
Normal file
20
.github/actions/setup-qt/action.yml
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
name: "Setup Qt"
|
||||
description: "Install clide dependencies"
|
||||
inputs:
|
||||
qt-version:
|
||||
description: "Qt version to install"
|
||||
required: true
|
||||
|
||||
runs:
|
||||
using: "composite"
|
||||
steps:
|
||||
- name: Install apt packages
|
||||
run: |
|
||||
sudo apt update -y
|
||||
sudo apt install -y build-essential cmake curl libgl1-mesa-dev python3 python3-pip
|
||||
shell: bash
|
||||
|
||||
- name: Install Qt
|
||||
uses: jurplel/install-qt-action@v4
|
||||
with:
|
||||
version: ${{ inputs.qt-version }}
|
||||
97
.github/workflows/check.yaml
vendored
Normal file
97
.github/workflows/check.yaml
vendored
Normal file
@@ -0,0 +1,97 @@
|
||||
name: Check
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- '**'
|
||||
tags:
|
||||
- 'v*'
|
||||
pull_request:
|
||||
|
||||
env:
|
||||
QT_VERSION: 6.7.3
|
||||
|
||||
jobs:
|
||||
Build:
|
||||
name: Build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Qt
|
||||
uses: ./.github/actions/setup-qt
|
||||
with:
|
||||
qt-version: ${{ env.QT_VERSION }}
|
||||
|
||||
- name: Build libclide
|
||||
run: |
|
||||
cargo b -p libclide --release
|
||||
- name: Build libclide-macros
|
||||
run: |
|
||||
cargo b -p libclide-macros --release
|
||||
- name: Build clide
|
||||
run: |
|
||||
cargo b --release
|
||||
|
||||
Test:
|
||||
name: Test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Qt
|
||||
uses: ./.github/actions/setup-qt
|
||||
with:
|
||||
qt-version: ${{ env.QT_VERSION }}
|
||||
|
||||
- name: Test libclide
|
||||
run: |
|
||||
cargo test -p libclide
|
||||
- name: Test libclide-macros
|
||||
run: |
|
||||
cargo test -p libclide-macros
|
||||
- name: Test clide
|
||||
run: |
|
||||
cargo test
|
||||
|
||||
Lint:
|
||||
name: Lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Qt
|
||||
uses: ./.github/actions/setup-qt
|
||||
with:
|
||||
qt-version: ${{ env.QT_VERSION }}
|
||||
|
||||
- name: Lint libclide
|
||||
run: |
|
||||
cargo clippy -p libclide -- -D warnings
|
||||
- name: Lint libclide-macros
|
||||
run: |
|
||||
cargo clippy -p libclide-macros -- -D warnings
|
||||
- name: Lint clide
|
||||
run: |
|
||||
cargo clippy -- -D warnings
|
||||
|
||||
Format:
|
||||
name: Format
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Qt
|
||||
uses: ./.github/actions/setup-qt
|
||||
with:
|
||||
qt-version: ${{ env.QT_VERSION }}
|
||||
|
||||
- name: Format libclide
|
||||
run: |
|
||||
cargo fmt -p libclide --verbose -- --check
|
||||
- name: Format libclide-macros
|
||||
run: |
|
||||
cargo fmt -p libclide-macros -- --check
|
||||
- name: Format clide
|
||||
run: |
|
||||
cargo fmt --verbose -- --check
|
||||
8
.gitignore
vendored
8
.gitignore
vendored
@@ -1,3 +1,5 @@
|
||||
/target
|
||||
.qtcreator
|
||||
.idea
|
||||
**/target/**
|
||||
**/.qtcreator/**
|
||||
**/.idea/**
|
||||
**/*.autosave/**
|
||||
**/.qmlls.ini
|
||||
|
||||
33
.qmllint.ini
Normal file
33
.qmllint.ini
Normal file
@@ -0,0 +1,33 @@
|
||||
[General]
|
||||
DisableDefaultImports=false
|
||||
|
||||
[Warnings]
|
||||
AccessSingletonViaObject=warning
|
||||
AttachedPropertyReuse=disable
|
||||
BadSignalHandlerParameters=warning
|
||||
CompilerWarnings=disable
|
||||
Deprecated=warning
|
||||
DuplicatePropertyBinding=warning
|
||||
DuplicatedName=warning
|
||||
ImportFailure=warning
|
||||
IncompatibleType=warning
|
||||
InheritanceCycle=warning
|
||||
InvalidLintDirective=warning
|
||||
LintPluginWarnings=disable
|
||||
MissingProperty=warning
|
||||
MissingType=warning
|
||||
MultilineStrings=info
|
||||
NonListProperty=warning
|
||||
PrefixedImportType=warning
|
||||
PropertyAliasCycles=warning
|
||||
ReadOnlyProperty=warning
|
||||
RequiredProperty=warning
|
||||
RestrictedType=warning
|
||||
TopLevelComponent=warning
|
||||
UncreatableType=warning
|
||||
UnqualifiedAccess=warning
|
||||
UnresolvedType=warning
|
||||
UnusedImports=info
|
||||
UseProperFunction=warning
|
||||
VarUsedBeforeDeclaration=warning
|
||||
WithStatement=warning
|
||||
2647
Cargo.lock
generated
2647
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
29
Cargo.toml
29
Cargo.toml
@@ -3,11 +3,34 @@ name = "clide"
|
||||
version = "0.1.0"
|
||||
edition = "2024"
|
||||
|
||||
[workspace]
|
||||
resolver = "3"
|
||||
members = [".", "libclide", "libclide-macros", ]
|
||||
|
||||
[workspace.dependencies]
|
||||
anyhow = "1.0.100"
|
||||
strum = "0.27.2"
|
||||
log = { version = "0.4.27", features = [] }
|
||||
devicons = "0.6.12"
|
||||
|
||||
[dependencies]
|
||||
cxx = "1.0.95"
|
||||
cxx-qt = "0.7"
|
||||
cxx-qt-lib = { version="0.7", features = ["qt_full"] }
|
||||
cxx-qt = "0.8.0"
|
||||
cxx-qt-lib = { version = "0.8.0", features = ["qt_full", "qt_gui", "qt_qml"] }
|
||||
dirs = "6.0.0"
|
||||
syntect = "5.2.0"
|
||||
clap = { version = "4.5.54", features = ["derive"] }
|
||||
ratatui = "0.30.0"
|
||||
tui-tree-widget = "0.24.0"
|
||||
tui-logger = "0.18.1"
|
||||
edtui = "0.11.1"
|
||||
libclide = { path = "./libclide" }
|
||||
libclide-macros = { path = "./libclide-macros" }
|
||||
anyhow = { workspace = true }
|
||||
strum = { workspace = true }
|
||||
log = { workspace = true }
|
||||
devicons = { workspace = true }
|
||||
|
||||
[build-dependencies]
|
||||
# The link_qt_object_files feature is required for statically linking Qt 6.
|
||||
cxx-qt-build = { version = "0.7", features = [ "link_qt_object_files" ] }
|
||||
cxx-qt-build = { version = "0.8.0", features = ["link_qt_object_files"] }
|
||||
|
||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
||||
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>.
|
||||
136
README.md
136
README.md
@@ -1,11 +1,18 @@
|
||||
# CLIDE
|
||||
|
||||
CLIDE is an IDE written in Rust that supports both full and headless Linux environments.
|
||||
[](https://github.com/shaunrd0/clide/actions/workflows/check.yaml)
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
```bash
|
||||
sudo apt install qt6-base-dev qt6-declarative-dev qt6-tools-dev qml6-module-qtquick-controls qml6-module-qtquick-layouts qml6-module-qtquick-window qml6-module-qtqml-workerscript qml6-module-qtquick-templates qml6-module-qtquick
|
||||
sudo apt install qt6-base-dev qt6-declarative-dev qt6-tools-dev qml6-module-qtquick-controls qml6-module-qtquick-layouts qml6-module-qtquick-window qml6-module-qtqml-workerscript qml6-module-qtquick-templates qml6-module-qtquick qml6-module-qtquick-dialogs qt6-svg-dev
|
||||
```
|
||||
|
||||
And of course, [Rust](https://www.rust-lang.org/tools/install).
|
||||
@@ -14,6 +21,96 @@ And of course, [Rust](https://www.rust-lang.org/tools/install).
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
```
|
||||
|
||||
This project requires at least Qt 6.7.3 To check your Qt version
|
||||
|
||||
```bash
|
||||
qmake6 -query QT_VERSION
|
||||
```
|
||||
|
||||
Use the [Qt Installer](https://www.qt.io/development/download) to download and install the Qt version of your choice.
|
||||
If the installer is run with `sudo`, the default install location is `/opt/Qt`, otherwise Qt will be installed into your home directory.
|
||||
|
||||
**You must set the QMAKE variable before building clide**. This should be a path to `qmake6` binary installed on your system.
|
||||
The following export is the default installation path for Qt 6.7 on Ubuntu 24.04
|
||||
|
||||
```bash
|
||||
export QMAKE=$HOME/Qt/6.7.3/gcc_64/bin/qmake6
|
||||
export LD_LIBRARY_PATH=$HOME/Qt/6.7.3/gcc_64/lib
|
||||
```
|
||||
|
||||
Though environment variables set using `export` will take precedence, these can also be set in [.cargo/config.toml](./.cargo/config.toml) for conveinence
|
||||
|
||||
```toml
|
||||
[env]
|
||||
QMAKE="/opt/Qt/6.7.3/gcc_64/bin/qmake6"
|
||||
LD_LIBRARY_PATH="/opt/Qt/6.7.3/gcc_64/lib"
|
||||
```
|
||||
|
||||
## 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
|
||||
|
||||
It's recommended to use RustRover or Qt Creator for development.
|
||||
@@ -22,10 +119,45 @@ The [Qt Installer](https://www.qt.io/download-qt-installer) will provide the lat
|
||||
If using RustRover be sure to set your QML binaries path in the settings menu.
|
||||
If Qt was installed to its default directory this will be `$HOME/Qt/6.8.3/gcc_64/bin/`.
|
||||
|
||||
Viewing documentation in the web browser is possible, but using Qt Assistant is recommended.
|
||||
It comes with Qt6 when installed. Run the following command to start it.
|
||||
|
||||
```bash
|
||||
nohup $HOME/Qt/6.8.3/gcc_64/bin/assistant > /dev/null 2>&1 &
|
||||
```
|
||||
|
||||
If you are looking for an include path from Qt
|
||||
|
||||
```bash
|
||||
find /usr/include/x86_64-linux-gnu/qt6/ -name QFile*
|
||||
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtWidgets/QFileIconProvider
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtWidgets/QFileDialog
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtGui/QFileSystemModel
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtGui/QFileOpenEvent
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtCore/QFile
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtCore/QFileDevice
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtCore/QFileSystemWatcher
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtCore/QFileInfoList
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtCore/QFileInfo
|
||||
/usr/include/x86_64-linux-gnu/qt6/QtCore/QFileSelector
|
||||
```
|
||||
|
||||
This helped find that QFileSystemModel is in QtGui and not QtCore.
|
||||
|
||||
### Resources
|
||||
|
||||
Some helpful links for reading up on QML if you're just getting started.
|
||||
|
||||
* [Rust Crates - cxx-qt](https://docs.rs/releases/search?query=cxx_qt)
|
||||
* [QML Reference](https://doc.qt.io/qt-6/qmlreference.html)
|
||||
* [QML Coding Conventions](https://doc.qt.io/qt-6/qml-codingconventions.html)
|
||||
* [All QML Controls Types](https://doc.qt.io/qt-6/qtquick-controls-qmlmodule.html)
|
||||
* [KDAB CXX-Qt Book](https://kdab.github.io/cxx-qt/book/)
|
||||
* [github.com/KDAB/cxx-qt](https://github.com/KDAB/cxx-qt)
|
||||
* [QML and C++ Intergration](https://doc.qt.io/qt-6/qtqml-cppintegration-overview.html)
|
||||
|
||||
|
||||
### Plugins
|
||||
|
||||
TODO: Add a list of plugins here. The first example will be C++ with CMake functionality.
|
||||
|
||||
32
build.rs
32
build.rs
@@ -1,21 +1,33 @@
|
||||
use cxx_qt_build::{CxxQtBuilder, QmlModule};
|
||||
|
||||
fn main() {
|
||||
CxxQtBuilder::new()
|
||||
CxxQtBuilder::new_qml_module(QmlModule::new("clide.module").qml_files([
|
||||
"qml/ClideApplicationView.qml",
|
||||
"qml/ClideEditorView.qml",
|
||||
"qml/ClideExplorerView.qml",
|
||||
"qml/ClideTreeView.qml",
|
||||
"qml/Components/ClideAboutWindow.qml",
|
||||
"qml/Components/ClideBreadCrumbs.qml",
|
||||
"qml/Components/ClideEditor.qml",
|
||||
"qml/Components/ClideHandle.qml",
|
||||
"qml/Components/ClideLogger.qml",
|
||||
"qml/Components/ClideMenu.qml",
|
||||
"qml/Components/ClideMenuBar.qml",
|
||||
"qml/Components/ClideMenuItem.qml",
|
||||
"qml/Components/ClideScrollBar.qml",
|
||||
"qml/Logger/Logger.qml",
|
||||
"qml/main.qml",
|
||||
]))
|
||||
// Link Qt's Network library
|
||||
// - Qt Core is always linked
|
||||
// - Qt Gui is linked by enabling the qt_gui Cargo feature of cxx-qt-lib.
|
||||
// - Qt Qml is linked by enabling the qt_qml Cargo feature of cxx-qt-lib.
|
||||
// - Qt Qml requires linking Qt Network on macOS
|
||||
.qt_module("Network")
|
||||
.qml_module(QmlModule {
|
||||
uri: "test",
|
||||
rust_files: &["src/main.rs"],
|
||||
qml_files: &["qml/main.qml",
|
||||
"qml/Menu/ClideMenu.qml",
|
||||
"qml/Menu/ClideMenuBar.qml",
|
||||
"qml/Menu/ClideMenuBarItem.qml"],
|
||||
..Default::default()
|
||||
})
|
||||
.qt_module("Gui")
|
||||
.qt_module("Svg")
|
||||
.qt_module("Xml")
|
||||
.qrc("./resources.qrc")
|
||||
.files(["src/gui/colors.rs", "src/gui/filesystem.rs"])
|
||||
.build();
|
||||
}
|
||||
|
||||
12
libclide-macros/Cargo.toml
Normal file
12
libclide-macros/Cargo.toml
Normal file
@@ -0,0 +1,12 @@
|
||||
[package]
|
||||
name = "libclide-macros"
|
||||
version = "0.1.0"
|
||||
edition = "2024"
|
||||
|
||||
[lib]
|
||||
proc-macro = true
|
||||
|
||||
[dependencies]
|
||||
syn = { version = "2", features = ["full"] }
|
||||
quote = "1"
|
||||
proc-macro2 = "1"
|
||||
24
libclide-macros/src/lib.rs
Normal file
24
libclide-macros/src/lib.rs
Normal file
@@ -0,0 +1,24 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use proc_macro::TokenStream;
|
||||
use quote::quote;
|
||||
use syn::{ItemStruct, parse_macro_input};
|
||||
|
||||
#[proc_macro_derive(Loggable)]
|
||||
pub fn loggable(item: TokenStream) -> TokenStream {
|
||||
let input = parse_macro_input!(item as ItemStruct);
|
||||
let struct_name = &input.ident;
|
||||
let generics = &input.generics;
|
||||
|
||||
let (impl_generics, type_generics, where_clause) = generics.split_for_impl();
|
||||
let struct_name_str = struct_name.to_string();
|
||||
let expanded = quote! {
|
||||
impl #impl_generics libclide::log::Loggable for #struct_name #type_generics #where_clause {
|
||||
const ID: &'static str = #struct_name_str;
|
||||
}
|
||||
};
|
||||
|
||||
TokenStream::from(expanded)
|
||||
}
|
||||
16
libclide/Cargo.lock
generated
Normal file
16
libclide/Cargo.lock
generated
Normal file
@@ -0,0 +1,16 @@
|
||||
# This file is automatically @generated by Cargo.
|
||||
# It is not intended for manual editing.
|
||||
version = 4
|
||||
|
||||
[[package]]
|
||||
name = "anyhow"
|
||||
version = "1.0.102"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c"
|
||||
|
||||
[[package]]
|
||||
name = "libclide"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
]
|
||||
11
libclide/Cargo.toml
Normal file
11
libclide/Cargo.toml
Normal file
@@ -0,0 +1,11 @@
|
||||
[package]
|
||||
name = "libclide"
|
||||
version = "0.1.0"
|
||||
edition = "2024"
|
||||
|
||||
[dependencies]
|
||||
anyhow = { workspace = true }
|
||||
strum = { workspace = true }
|
||||
log = { workspace = true }
|
||||
devicons = { workspace = true }
|
||||
libclide-macros = { path = "../libclide-macros" }
|
||||
7
libclide/src/fs.rs
Normal file
7
libclide/src/fs.rs
Normal file
@@ -0,0 +1,7 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
pub mod entry_meta;
|
||||
|
||||
pub use entry_meta::icon;
|
||||
64
libclide/src/fs/entry_meta.rs
Normal file
64
libclide/src/fs/entry_meta.rs
Normal file
@@ -0,0 +1,64 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use anyhow::{Context, Result};
|
||||
use devicons::FileIcon;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct EntryMeta {
|
||||
pub abs_path: String,
|
||||
pub file_name: String,
|
||||
pub is_dir: bool,
|
||||
pub icon: FileIcon,
|
||||
}
|
||||
|
||||
impl EntryMeta {
|
||||
/// Normalizes a path, returning an absolute from the root of the filesystem.
|
||||
/// Does not resolve symlinks and extracts `./` or `../` segments.
|
||||
fn normalize<P: AsRef<Path>>(p: P) -> PathBuf {
|
||||
let path = p.as_ref();
|
||||
let mut buf = PathBuf::new();
|
||||
|
||||
for comp in path.components() {
|
||||
match comp {
|
||||
std::path::Component::ParentDir => {
|
||||
buf.pop();
|
||||
}
|
||||
std::path::Component::CurDir => {}
|
||||
_ => buf.push(comp),
|
||||
}
|
||||
}
|
||||
|
||||
buf
|
||||
}
|
||||
|
||||
pub fn new<P: AsRef<Path>>(p: P) -> Result<Self> {
|
||||
let path = p.as_ref();
|
||||
let is_dir = path.is_dir();
|
||||
let abs_path = Self::normalize(path).to_string_lossy().to_string();
|
||||
let file_name = Path::new(&abs_path)
|
||||
.file_name()
|
||||
.context(format!("Failed to get file name for path: {abs_path:?}"))?
|
||||
.to_string_lossy()
|
||||
.to_string();
|
||||
let icon = crate::fs::icon(&abs_path);
|
||||
Ok(EntryMeta {
|
||||
abs_path,
|
||||
file_name,
|
||||
is_dir,
|
||||
icon,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
pub fn icon<P: AsRef<str>>(p: P) -> FileIcon {
|
||||
let path = p.as_ref();
|
||||
if Path::new(&path).is_dir() {
|
||||
// Ensures directories are given a folder icon and not mistakenly resolved to a language.
|
||||
// For example, a directory named `cpp` would otherwise return a C++ icon.
|
||||
return FileIcon::from("dir/");
|
||||
}
|
||||
FileIcon::from(path)
|
||||
}
|
||||
7
libclide/src/lib.rs
Normal file
7
libclide/src/lib.rs
Normal file
@@ -0,0 +1,7 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
pub mod fs;
|
||||
pub mod log;
|
||||
pub mod theme;
|
||||
9
libclide/src/log.rs
Normal file
9
libclide/src/log.rs
Normal file
@@ -0,0 +1,9 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
pub mod macros;
|
||||
|
||||
pub trait Loggable {
|
||||
const ID: &'static str;
|
||||
}
|
||||
75
libclide/src/log/macros.rs
Normal file
75
libclide/src/log/macros.rs
Normal file
@@ -0,0 +1,75 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
//! Logging targets allow filtering of log messages by their source. By default, the log crate sets
|
||||
//! the target to the module path where the log macro was invoked if no target is provided.
|
||||
//!
|
||||
//! These macros essentially disable using the default target and instead require the target to be
|
||||
//! explicitly set. This is to avoid implicit pooling of log messages under the same default target,
|
||||
//! which can make it difficult to filter log messages by their source.
|
||||
//!
|
||||
//! The Loggable trait can be implemented to automatically associate log messages with a struct.
|
||||
//! ```
|
||||
//! use libclide_macros::Loggable;
|
||||
//!
|
||||
//! #[derive(Loggable)]
|
||||
//! struct MyStruct;
|
||||
//! impl MyStruct {
|
||||
//! fn my_method(&self) {
|
||||
//! libclide::info!("This log message will use target <Self as Loggable>::ID, which is 'MyStruct'");
|
||||
//! }
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! If the struct does not derive or implement Loggable, the target variant of the log macros must
|
||||
//! be used instead.
|
||||
//! ```
|
||||
//! libclide::info!(target: "CustomTarget", "This log message will have the target 'CustomTarget'");
|
||||
//! ```
|
||||
//!
|
||||
|
||||
#[macro_export]
|
||||
macro_rules! info {
|
||||
(target: $target:expr, $($arg:tt)+) => ({
|
||||
log::info!(target: $target, $($arg)+)
|
||||
});
|
||||
|
||||
($($arg:tt)+) => (log::info!(target: <Self as libclide::log::Loggable>::ID, $($arg)+))
|
||||
}
|
||||
|
||||
#[macro_export]
|
||||
macro_rules! debug {
|
||||
(target: $target:expr, $($arg:tt)+) => ({
|
||||
log::debug!(target: $target, $($arg)+)
|
||||
});
|
||||
|
||||
($($arg:tt)+) => (log::debug!(target: <Self as libclide::log::Loggable>::ID, $($arg)+))
|
||||
}
|
||||
|
||||
#[macro_export]
|
||||
macro_rules! warn {
|
||||
(target: $target:expr, $($arg:tt)+) => ({
|
||||
log::warn!(target: $target, $($arg)+)
|
||||
});
|
||||
|
||||
($($arg:tt)+) => (log::warn!(target: <Self as libclide::log::Loggable>::ID, $($arg)+))
|
||||
}
|
||||
|
||||
#[macro_export]
|
||||
macro_rules! error {
|
||||
(target: $target:expr, $($arg:tt)+) => ({
|
||||
log::error!(target: $target, $($arg)+)
|
||||
});
|
||||
|
||||
($($arg:tt)+) => (log::error!(target: <Self as libclide::log::Loggable>::ID, $($arg)+))
|
||||
}
|
||||
|
||||
#[macro_export]
|
||||
macro_rules! trace {
|
||||
(target: $target:expr, $($arg:tt)+) => ({
|
||||
log::trace!(target: $target, $($arg)+)
|
||||
});
|
||||
|
||||
($($arg:tt)+) => (log::trace!(target: <Self as libclide::log::Loggable>::ID, $($arg)+))
|
||||
}
|
||||
5
libclide/src/theme.rs
Normal file
5
libclide/src/theme.rs
Normal file
@@ -0,0 +1,5 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
pub mod colors;
|
||||
54
libclide/src/theme/colors.rs
Normal file
54
libclide/src/theme/colors.rs
Normal file
@@ -0,0 +1,54 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
/// Colors shared between the TUI and GUI for the current theme.
|
||||
pub struct Colors {}
|
||||
impl Colors {
|
||||
pub const HOVERED: &str = "#303234";
|
||||
pub const UNHOVERED: &str = "#3c3f41";
|
||||
pub const PRESSED: &str = "#4b4f51";
|
||||
pub const MENUBAR: &str = "#262626";
|
||||
pub const MENUBAR_BORDER: &str = "#575757";
|
||||
pub const SCROLLBAR: &str = "#4b4f51";
|
||||
pub const SCROLLBAR_ACTIVE: &str = "#4b4f51";
|
||||
pub const SCROLLBAR_GUTTER: &str = "#3b3b3b";
|
||||
pub const LINENUMBER: &str = "#94989b";
|
||||
pub const ACTIVE: &str = "#d1d33f";
|
||||
pub const INACTIVE: &str = "#FFF";
|
||||
pub const EDITOR_BACKGROUND: &str = "#1E1F22";
|
||||
pub const EDITOR_TEXT: &str = "#acaea3";
|
||||
pub const EDITOR_HIGHLIGHTED_TEXT: &str = "#ccced3";
|
||||
pub const EDITOR_HIGHLIGHT: &str = "#ccced3";
|
||||
pub const GUTTER: &str = "#1e1f22";
|
||||
pub const EXPLORER_HOVERED: &str = "#4c5053";
|
||||
pub const EXPLORER_TEXT: &str = "#FFF";
|
||||
pub const EXPLORER_TEXT_SELECTED: &str = "#262626";
|
||||
pub const EXPLORER_BACKGROUND: &str = "#1E1F22";
|
||||
pub const EXPLORER_FOLDER: &str = "#54585b";
|
||||
pub const EXPLORER_FOLDER_OPEN: &str = "#393B40";
|
||||
pub const TERMINAL_BACKGROUND: &str = "#111111";
|
||||
pub const INFO_LOG: &str = "#C4FFFF";
|
||||
pub const DEBUG_LOG: &str = "#9148AF";
|
||||
pub const WARN_LOG: &str = "#C4A958";
|
||||
pub const ERROR_LOG: &str = "#ff5555";
|
||||
pub const TRACE_LOG: &str = "#ffaa00";
|
||||
|
||||
/// Converts a CSS hex color string (e.g., "#RRGGBB" or "#RGB") to u32 in 0x00RRGGBB format.
|
||||
pub fn css_to_u32(css: &str) -> u32 {
|
||||
let hex = css.trim_start_matches('#');
|
||||
// Expand shorthand #RGB to #RRGGBB
|
||||
let hex_full = match hex.len() {
|
||||
3 => hex
|
||||
.chars()
|
||||
.map(|c| std::iter::repeat_n(c, 2).collect::<String>())
|
||||
.collect::<String>(),
|
||||
6 => hex.to_string(),
|
||||
_ => panic!("Invalid hex color length: {hex:?}"),
|
||||
};
|
||||
// Parse the hex string as u32, masking to ensure the top (alpha) byte is 0x00.
|
||||
u32::from_str_radix(&hex_full, 16)
|
||||
.map(|rgb| rgb & 0x00FF_FFFF)
|
||||
.unwrap_or_else(|e| panic!("Failed to parse hex: {e:?}"))
|
||||
}
|
||||
}
|
||||
46
qml/ClideApplicationView.qml
Normal file
46
qml/ClideApplicationView.qml
Normal file
@@ -0,0 +1,46 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
import QtQuick.Layouts
|
||||
|
||||
import clide.module 1.0
|
||||
import Logger 1.0
|
||||
|
||||
SplitView {
|
||||
id: root
|
||||
|
||||
// Path to the directory of the project opened in clide.
|
||||
required property string projectDir
|
||||
|
||||
anchors.fill: parent
|
||||
|
||||
// Customized handle to drag between the Navigation and the Editor.
|
||||
handle: ClideHandle {
|
||||
hovered: SplitHandle.hovered
|
||||
pressed: SplitHandle.pressed
|
||||
}
|
||||
|
||||
ClideExplorerView {
|
||||
SplitView.fillHeight: true
|
||||
SplitView.preferredWidth: 200
|
||||
projectDir: root.projectDir
|
||||
|
||||
// Open files when clicked in the explorer.
|
||||
onFileClicked: path => {
|
||||
Logger.trace("Setting editor path from ClideExplorerView signal: " + path)
|
||||
clideEditorView.filePath = path;
|
||||
}
|
||||
}
|
||||
ClideEditorView {
|
||||
id: clideEditorView
|
||||
|
||||
SplitView.fillHeight: true
|
||||
SplitView.fillWidth: true
|
||||
// Provide a path to the file currently open in the text editor.
|
||||
// Initialized using the Default trait in Rust QML singleton FileSystem.
|
||||
filePath: FileSystem.filePath
|
||||
}
|
||||
}
|
||||
49
qml/ClideEditorView.qml
Normal file
49
qml/ClideEditorView.qml
Normal file
@@ -0,0 +1,49 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
import QtQuick.Layouts
|
||||
|
||||
import clide.module 1.0
|
||||
import Logger 1.0
|
||||
|
||||
Rectangle {
|
||||
id: root
|
||||
|
||||
// The path to the file to show in the text editor.
|
||||
// This is updated by a signal caught within ClideApplicationView.
|
||||
required property string filePath
|
||||
|
||||
clip: true
|
||||
color: "transparent"
|
||||
radius: 20
|
||||
|
||||
SplitView {
|
||||
anchors.fill: parent
|
||||
orientation: Qt.Vertical
|
||||
spacing: 3
|
||||
|
||||
// Customized handle to drag between the Editor and the Console.
|
||||
handle: ClideHandle {
|
||||
hovered: SplitHandle.hovered
|
||||
pressed: SplitHandle.pressed
|
||||
}
|
||||
|
||||
Component.onCompleted: {
|
||||
// Show logging is working.
|
||||
Logger.info("Info logs");
|
||||
Logger.warn("Warning logs");
|
||||
Logger.debug("Debug logs");
|
||||
Logger.error("Error logs");
|
||||
Logger.trace("Trace logs");
|
||||
}
|
||||
|
||||
ClideEditor {
|
||||
SplitView.preferredHeight: 650
|
||||
}
|
||||
ClideLogger {
|
||||
}
|
||||
}
|
||||
}
|
||||
62
qml/ClideExplorerView.qml
Normal file
62
qml/ClideExplorerView.qml
Normal file
@@ -0,0 +1,62 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
import QtQuick.Layouts
|
||||
|
||||
import clide.module 1.0
|
||||
import Logger 1.0
|
||||
|
||||
Rectangle {
|
||||
id: root
|
||||
|
||||
required property string projectDir
|
||||
|
||||
signal fileClicked(string path)
|
||||
|
||||
clip: true
|
||||
color: RustColors.explorer_background
|
||||
topLeftRadius: 10
|
||||
|
||||
ColumnLayout {
|
||||
anchors.fill: parent
|
||||
spacing: 5
|
||||
|
||||
ClideBreadCrumbs {
|
||||
id: breadCrumb
|
||||
|
||||
Layout.fillWidth: true
|
||||
Layout.leftMargin: 15
|
||||
Layout.rightMargin: 15
|
||||
Layout.topMargin: 10
|
||||
path: clideTreeView.rootDirectory
|
||||
|
||||
onCrumbClicked: path => {
|
||||
Logger.trace("Crumb clicked: " + path);
|
||||
clideTreeView.rootDirectory = path;
|
||||
}
|
||||
onResetRoot: {
|
||||
clideTreeView.rootDirectory = clideTreeView.originalRootDirectory;
|
||||
}
|
||||
}
|
||||
ClideTreeView {
|
||||
id: clideTreeView
|
||||
|
||||
Layout.fillHeight: true
|
||||
Layout.fillWidth: true
|
||||
|
||||
// Path to the directory opened in the file explorer.
|
||||
originalRootDirectory: root.projectDir
|
||||
rootDirectory: root.projectDir
|
||||
|
||||
// Pass the signal to the parent component using another signal.
|
||||
onFileClicked: path => root.fileClicked(path)
|
||||
onRootDirectoryChanged: {
|
||||
Logger.log("Setting root directory: " + clideTreeView.rootDirectory);
|
||||
breadCrumb.path = clideTreeView.rootDirectory;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
166
qml/ClideTreeView.qml
Normal file
166
qml/ClideTreeView.qml
Normal file
@@ -0,0 +1,166 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Effects
|
||||
import QtQuick.Controls
|
||||
|
||||
import clide.module 1.0
|
||||
import Logger 1.0
|
||||
|
||||
TreeView {
|
||||
id: root
|
||||
|
||||
property int lastIndex: -1
|
||||
required property string originalRootDirectory
|
||||
property string rootDirectory
|
||||
property int rootIndent: 25
|
||||
|
||||
signal fileClicked(string filePath)
|
||||
|
||||
boundsBehavior: Flickable.StopAtBounds
|
||||
boundsMovement: Flickable.StopAtBounds
|
||||
clip: true
|
||||
|
||||
// The model is implemented in filesystem.rs
|
||||
model: FileSystem
|
||||
// Set the root directory on the Rust model, returning the QModeIndex to use for the root of the tree view widget.
|
||||
rootIndex: FileSystem.setDirectory(root.rootDirectory)
|
||||
|
||||
// Provide our own custom ScrollIndicator for the TreeView.
|
||||
ScrollBar.horizontal: ClideScrollBar {
|
||||
sizeModifier: 3
|
||||
}
|
||||
ScrollBar.vertical: ClideScrollBar {
|
||||
sizeModifier: 3
|
||||
}
|
||||
|
||||
// The delegate represents a single entry in the filesystem.
|
||||
delegate: TreeViewDelegate {
|
||||
id: treeDelegate
|
||||
|
||||
required property string fileName
|
||||
required property url filePath
|
||||
required property int index
|
||||
|
||||
implicitHeight: 25
|
||||
implicitWidth: root.width
|
||||
indentation: 12
|
||||
|
||||
background: Rectangle {
|
||||
color: current ? RustColors.explorer_folder_open : "transparent"
|
||||
radius: 20
|
||||
width: root.width
|
||||
}
|
||||
// Item name.
|
||||
contentItem: Text {
|
||||
anchors.left: itemIcon.right
|
||||
anchors.leftMargin: 5
|
||||
color: RustColors.explorer_text
|
||||
text: treeDelegate.fileName
|
||||
}
|
||||
// Item Icon.
|
||||
indicator: Label {
|
||||
id: itemIcon
|
||||
|
||||
anchors.verticalCenter: parent.verticalCenter
|
||||
antialiasing: true
|
||||
enabled: false
|
||||
focus: false
|
||||
font.family: localFont.font.family
|
||||
font.pixelSize: 18
|
||||
smooth: true
|
||||
// Get the icon from Rust implementation.
|
||||
text: root.model.icon(filePath)
|
||||
x: root.rootIndent + (treeDelegate.depth * treeDelegate.indentation) + (carrotIndicator.visible ? carrotIndicator.width : 0)
|
||||
}
|
||||
|
||||
// Directory carrot indicator.
|
||||
Label {
|
||||
id: carrotIndicator
|
||||
|
||||
anchors.verticalCenter: parent.verticalCenter
|
||||
font.family: localFont.font.family
|
||||
font.pixelSize: 10
|
||||
font.weight: localFont.font.weight
|
||||
text: expanded ? "⮟" : "⮞"
|
||||
visible: isTreeNode && hasChildren
|
||||
x: (root.rootIndent - implicitWidth) + (depth * indentation)
|
||||
}
|
||||
// Apply colorization effects to the icon for the item.
|
||||
MultiEffect {
|
||||
anchors.fill: itemIcon
|
||||
brightness: 1.0
|
||||
colorization: 1.0
|
||||
colorizationColor: {
|
||||
const isFile = !treeDelegate.hasChildren;
|
||||
if (isFile)
|
||||
return Qt.lighter(RustColors.explorer_folder, 2);
|
||||
const isExpandedFolder = treeDelegate.expanded && treeDelegate.hasChildren;
|
||||
if (isExpandedFolder)
|
||||
return Qt.darker(RustColors.explorer_folder, 2);
|
||||
else
|
||||
return RustColors.explorer_folder;
|
||||
}
|
||||
source: itemIcon
|
||||
}
|
||||
HoverHandler {
|
||||
id: hoverHandler
|
||||
|
||||
acceptedDevices: PointerDevice.Mouse
|
||||
}
|
||||
TapHandler {
|
||||
acceptedButtons: Qt.LeftButton | Qt.RightButton
|
||||
|
||||
onSingleTapped: (eventPoint, button) => {
|
||||
switch (button) {
|
||||
case Qt.LeftButton:
|
||||
if (treeDelegate.hasChildren) {
|
||||
root.toggleExpanded(treeDelegate.row);
|
||||
} else {
|
||||
// If this model item doesn't have children, it means it's representing a file.
|
||||
root.fileClicked(treeDelegate.filePath);
|
||||
}
|
||||
break;
|
||||
case Qt.RightButton:
|
||||
contextMenu.popup();
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
ClideMenu {
|
||||
id: contextMenu
|
||||
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
enabled: treeDelegate.hasChildren
|
||||
text: qsTr("Set root")
|
||||
|
||||
onTriggered: {
|
||||
Logger.debug("Setting new root directory: " + treeDelegate.filePath);
|
||||
root.rootDirectory = treeDelegate.filePath;
|
||||
}
|
||||
}
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
text: qsTr("Reset root")
|
||||
|
||||
onTriggered: {
|
||||
Logger.log("Resetting root directory: " + root.originalRootDirectory);
|
||||
root.rootDirectory = root.originalRootDirectory;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
selectionModel: ItemSelectionModel {
|
||||
}
|
||||
|
||||
FontLoader {
|
||||
id: localFont
|
||||
|
||||
source: "qrc:/fonts/saucecodepro-xlight.ttf"
|
||||
}
|
||||
}
|
||||
69
qml/Components/ClideAboutWindow.qml
Normal file
69
qml/Components/ClideAboutWindow.qml
Normal file
@@ -0,0 +1,69 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls.Basic
|
||||
|
||||
import clide.module 1.0
|
||||
import Logger 1.0
|
||||
|
||||
ApplicationWindow {
|
||||
id: root
|
||||
|
||||
color: RustColors.gutter
|
||||
// Create the window with no frame and keep it on top.
|
||||
flags: Qt.Tool | Qt.FramelessWindowHint
|
||||
height: 350
|
||||
width: 450
|
||||
visible: root.active
|
||||
|
||||
// Hide the window when it loses focus.
|
||||
onActiveChanged: {
|
||||
Logger.debug("Setting active: " + root.active)
|
||||
if (!root.active) {
|
||||
root.visible = false;
|
||||
}
|
||||
}
|
||||
|
||||
// Kilroy logo.
|
||||
Image {
|
||||
id: logo
|
||||
|
||||
anchors.left: parent.left
|
||||
anchors.margins: 20
|
||||
anchors.right: parent.right
|
||||
anchors.top: parent.top
|
||||
antialiasing: true
|
||||
asynchronous: true
|
||||
fillMode: Image.PreserveAspectFit
|
||||
smooth: true
|
||||
source: "qrc:/images/kilroy.png"
|
||||
sourceSize.height: 80
|
||||
sourceSize.width: 80
|
||||
}
|
||||
ScrollView {
|
||||
anchors.bottom: parent.bottom
|
||||
anchors.left: parent.left
|
||||
anchors.margins: 20
|
||||
anchors.right: parent.right
|
||||
anchors.top: logo.bottom
|
||||
|
||||
TextArea {
|
||||
antialiasing: true
|
||||
background: null
|
||||
color: RustColors.editor_text
|
||||
horizontalAlignment: Text.AlignHCenter
|
||||
readOnly: true
|
||||
selectedTextColor: RustColors.editor_highlighted_text
|
||||
selectionColor: RustColors.editor_highlight
|
||||
text: qsTr("<h3>About CLIDE</h3>" + "<p>A simple text editor written in Rust and QML using CXX-Qt.</p>" + "<p>Personal website <a href=\"http://shaunreed.com\">shaunreed.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><a href=\"https://github.com/KDAB/cxx-qt\">KDAB CXX-Qt repository</a></p>" + "<p>Copyright (C) 2026 Shaun Reed, all rights reserved.</p>")
|
||||
textFormat: Text.RichText
|
||||
wrapMode: Text.WordWrap
|
||||
|
||||
onLinkActivated: function (link) {
|
||||
Qt.openUrlExternally(link);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
111
qml/Components/ClideBreadCrumbs.qml
Normal file
111
qml/Components/ClideBreadCrumbs.qml
Normal file
@@ -0,0 +1,111 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick 2.15
|
||||
import QtQuick.Controls 2.15
|
||||
import QtQuick.Layouts 1.15
|
||||
|
||||
import clide.module 1.0
|
||||
import Logger 1.0
|
||||
|
||||
Rectangle {
|
||||
id: root
|
||||
|
||||
property var fullPaths: []
|
||||
required property string path
|
||||
property var segments: []
|
||||
|
||||
signal crumbClicked(string path)
|
||||
signal resetRoot
|
||||
|
||||
function rebuildSegments(): string {
|
||||
let cleaned = path;
|
||||
if (cleaned.endsWith("/"))
|
||||
cleaned = cleaned.slice(0, -1);
|
||||
Logger.trace("Building segments for path: " + cleaned);
|
||||
segments = ["/"];
|
||||
fullPaths = ["/"];
|
||||
let parts = cleaned.split("/");
|
||||
let current = "";
|
||||
// We already pushed the root `/` path during initialization, so skip index 0.
|
||||
for (let i = 1; i < parts.length; ++i) {
|
||||
current += "/" + parts[i];
|
||||
Logger.trace("Pushing path: " + parts[i] + " Current: " + current);
|
||||
segments.push(parts[i]);
|
||||
fullPaths.push(current);
|
||||
}
|
||||
// Update the model used in the Repeater to show the new segments.
|
||||
repeater.model = segments;
|
||||
}
|
||||
|
||||
color: "transparent"
|
||||
implicitHeight: breadcrumbRow.implicitHeight
|
||||
width: parent.width
|
||||
|
||||
Component.onCompleted: rebuildSegments()
|
||||
onPathChanged: rebuildSegments()
|
||||
|
||||
Flow {
|
||||
id: breadcrumbRow
|
||||
|
||||
anchors.fill: parent
|
||||
spacing: 2
|
||||
width: parent.width
|
||||
|
||||
Repeater {
|
||||
id: repeater
|
||||
|
||||
model: root.segments
|
||||
|
||||
delegate: Text {
|
||||
required property int index
|
||||
required property string modelData
|
||||
|
||||
function getText(): string {
|
||||
if (modelData === "/") {
|
||||
return modelData;
|
||||
}
|
||||
return modelData + "/";
|
||||
}
|
||||
|
||||
// Show blue underlined hyperlink text if the mouse is hovering a segment.
|
||||
color: mouseArea.containsMouse ? "#2a7fff" : RustColors.explorer_text
|
||||
font.underline: mouseArea.containsMouse
|
||||
text: getText()
|
||||
|
||||
// Click events for each path segment call signal so the parent can set the file explorer root path.
|
||||
MouseArea {
|
||||
id: mouseArea
|
||||
|
||||
anchors.fill: parent
|
||||
hoverEnabled: true
|
||||
|
||||
onClicked: {
|
||||
Logger.info(index + "] Breadcrumb clicked:" + root.fullPaths[index]);
|
||||
crumbClicked(root.fullPaths[index]);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
TapHandler {
|
||||
acceptedButtons: Qt.RightButton
|
||||
|
||||
onSingleTapped: contextMenu.popup()
|
||||
}
|
||||
ClideMenu {
|
||||
id: contextMenu
|
||||
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
text: qsTr("Reset root")
|
||||
|
||||
onTriggered: {
|
||||
Logger.info("Resetting root directory from ClideBreadCrumbs");
|
||||
resetRoot();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
116
qml/Components/ClideEditor.qml
Normal file
116
qml/Components/ClideEditor.qml
Normal file
@@ -0,0 +1,116 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
import QtQuick.Layouts
|
||||
|
||||
import clide.module 1.0
|
||||
import Logger 1.0
|
||||
|
||||
Rectangle {
|
||||
color: RustColors.editor_background
|
||||
|
||||
RowLayout {
|
||||
anchors.fill: parent
|
||||
|
||||
// We use a flickable to synchronize the position of the editor and
|
||||
// the line numbers. This is necessary because the line numbers can
|
||||
// extend the available height.
|
||||
Flickable {
|
||||
id: lineNumbers
|
||||
|
||||
Layout.fillHeight: true
|
||||
Layout.fillWidth: false
|
||||
// Calculating the width correctly is important as the number grows.
|
||||
// We need to ensure space required to show N line number digits.
|
||||
// We use log10 to find how many digits are needed in a line number.
|
||||
// log10(9) ~= .95; log10(10) = 1.0; log10(100) = 2.0 ...etc
|
||||
// We +1 to ensure space for at least 1 digit, as floor(1.95) = 1.
|
||||
// The +10 is additional spacing and can be adjusted.
|
||||
Layout.preferredWidth: fontMetrics.averageCharacterWidth * (Math.floor(Math.log10(textArea.lineCount)) + 1) + 10
|
||||
contentY: editorFlickable.contentY
|
||||
interactive: false
|
||||
|
||||
Column {
|
||||
anchors.fill: parent
|
||||
topPadding: textArea.topPadding
|
||||
|
||||
Repeater {
|
||||
id: repeatedLineNumbers
|
||||
|
||||
// TODO: Bug where text wrapping shows as new line number.
|
||||
model: textArea.lineCount
|
||||
|
||||
// This Item is used for each line number in the gutter.
|
||||
delegate: Item {
|
||||
required property int index
|
||||
|
||||
// Calculates the height of each line in the text area.
|
||||
height: textArea.contentHeight / textArea.lineCount
|
||||
width: parent.width
|
||||
|
||||
// Show the line number.
|
||||
Label {
|
||||
id: numbers
|
||||
|
||||
color: RustColors.linenumber
|
||||
font: textArea.font
|
||||
height: parent.height
|
||||
horizontalAlignment: Text.AlignLeft
|
||||
text: parent.index + 1
|
||||
verticalAlignment: Text.AlignVCenter
|
||||
width: parent.width - indicator.width
|
||||
}
|
||||
// Draw an edge along the right side of the line number.
|
||||
Rectangle {
|
||||
id: indicator
|
||||
|
||||
anchors.left: numbers.right
|
||||
color: RustColors.linenumber
|
||||
height: parent.height
|
||||
width: 1
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Flickable {
|
||||
id: editorFlickable
|
||||
|
||||
Layout.fillHeight: true
|
||||
Layout.fillWidth: true
|
||||
boundsBehavior: Flickable.StopAtBounds
|
||||
height: 650
|
||||
|
||||
ScrollBar.horizontal: ClideScrollBar {
|
||||
}
|
||||
ScrollBar.vertical: ClideScrollBar {
|
||||
}
|
||||
TextArea.flickable: TextArea {
|
||||
id: textArea
|
||||
|
||||
antialiasing: true
|
||||
focus: true
|
||||
persistentSelection: true
|
||||
selectByMouse: true
|
||||
selectedTextColor: RustColors.editor_highlighted_text
|
||||
selectionColor: RustColors.editor_highlight
|
||||
text: FileSystem.readFile(root.filePath)
|
||||
textFormat: Qt.AutoText
|
||||
wrapMode: TextArea.Wrap
|
||||
|
||||
onLinkActivated: function (link) {
|
||||
Qt.openUrlExternally(link);
|
||||
}
|
||||
}
|
||||
|
||||
FontMetrics {
|
||||
id: fontMetrics
|
||||
|
||||
font: textArea.font
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
44
qml/Components/ClideHandle.qml
Normal file
44
qml/Components/ClideHandle.qml
Normal file
@@ -0,0 +1,44 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
|
||||
import clide.module 1.0
|
||||
|
||||
Rectangle {
|
||||
id: root
|
||||
|
||||
readonly property color currentColor: {
|
||||
if (pressed) {
|
||||
return RustColors.pressed;
|
||||
} else if (hovered) {
|
||||
return RustColors.hovered;
|
||||
} else {
|
||||
return "transparent";
|
||||
}
|
||||
}
|
||||
required property bool hovered
|
||||
required property bool pressed
|
||||
|
||||
border.color: currentColor
|
||||
color: currentColor
|
||||
implicitHeight: 8
|
||||
implicitWidth: 8
|
||||
radius: 2.5
|
||||
opacity: root.hovered ? 1.0 : 0.0
|
||||
|
||||
// Execute these behaviors when the color is changed.
|
||||
Behavior on color {
|
||||
ColorAnimation {
|
||||
duration: 500
|
||||
}
|
||||
}
|
||||
|
||||
Behavior on opacity {
|
||||
OpacityAnimator {
|
||||
duration: 500
|
||||
}
|
||||
}
|
||||
}
|
||||
60
qml/Components/ClideLogger.qml
Normal file
60
qml/Components/ClideLogger.qml
Normal file
@@ -0,0 +1,60 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
|
||||
import clide.module 1.0
|
||||
import Logger 1.0
|
||||
|
||||
Rectangle {
|
||||
color: RustColors.terminal_background
|
||||
radius: 10
|
||||
|
||||
ListModel {
|
||||
id: model
|
||||
|
||||
}
|
||||
ListView {
|
||||
id: listView
|
||||
|
||||
function getLogColor(level) {
|
||||
switch (level) {
|
||||
case "INFO":
|
||||
return RustColors.info_log;
|
||||
case "DEBUG":
|
||||
return RustColors.debug_log;
|
||||
case "WARN":
|
||||
return RustColors.warn_log;
|
||||
case "ERROR":
|
||||
return RustColors.error_log;
|
||||
case "TRACE":
|
||||
return RustColors.trace_log;
|
||||
default:
|
||||
return RustColors.info_log;
|
||||
}
|
||||
}
|
||||
|
||||
anchors.fill: parent
|
||||
model: model
|
||||
|
||||
delegate: Text {
|
||||
color: listView.getLogColor(level)
|
||||
font.family: "monospace"
|
||||
text: `[${level}] ${message}`
|
||||
}
|
||||
|
||||
onCountChanged: Qt.callLater(positionViewAtEnd)
|
||||
}
|
||||
Connections {
|
||||
function onLogged(level, message) {
|
||||
model.append({
|
||||
level,
|
||||
message
|
||||
});
|
||||
}
|
||||
|
||||
target: Logger
|
||||
}
|
||||
}
|
||||
18
qml/Components/ClideMenu.qml
Normal file
18
qml/Components/ClideMenu.qml
Normal file
@@ -0,0 +1,18 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls.Basic
|
||||
|
||||
import clide.module 1.0
|
||||
|
||||
Menu {
|
||||
background: Rectangle {
|
||||
border.color: RustColors.hovered
|
||||
border.width: 10
|
||||
color: RustColors.menubar
|
||||
implicitWidth: 100
|
||||
radius: 5
|
||||
}
|
||||
}
|
||||
153
qml/Components/ClideMenuBar.qml
Normal file
153
qml/Components/ClideMenuBar.qml
Normal file
@@ -0,0 +1,153 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
|
||||
import clide.module 1.0
|
||||
|
||||
MenuBar {
|
||||
// Background for this MenuBar.
|
||||
background: Rectangle {
|
||||
color: RustColors.menubar
|
||||
}
|
||||
|
||||
//
|
||||
// File Menu
|
||||
ClideMenu {
|
||||
title: qsTr("&File")
|
||||
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionNewProject
|
||||
|
||||
text: qsTr("&New Project...")
|
||||
}
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionOpen
|
||||
|
||||
text: qsTr("&Open...")
|
||||
}
|
||||
|
||||
onTriggered: FileSystem.setDirectory(FileSystem.filePath)
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionSave
|
||||
|
||||
text: qsTr("&Save")
|
||||
}
|
||||
}
|
||||
MenuSeparator {
|
||||
background: Rectangle {
|
||||
border.color: color
|
||||
color: Qt.darker(RustColors.menubar, 1)
|
||||
implicitHeight: 3
|
||||
implicitWidth: 200
|
||||
}
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionExit
|
||||
|
||||
text: qsTr("&Exit")
|
||||
|
||||
onTriggered: Qt.quit()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//
|
||||
// Edit Menu
|
||||
ClideMenu {
|
||||
title: qsTr("&Edit")
|
||||
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionUndo
|
||||
|
||||
text: qsTr("&Undo")
|
||||
}
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionRedo
|
||||
|
||||
text: qsTr("&Redo")
|
||||
}
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionCut
|
||||
|
||||
text: qsTr("&Cut")
|
||||
}
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionCopy
|
||||
|
||||
text: qsTr("&Copy")
|
||||
}
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionPaste
|
||||
|
||||
text: qsTr("&Paste")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//
|
||||
// View Menu
|
||||
ClideMenu {
|
||||
title: qsTr("&View")
|
||||
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionAppearance
|
||||
|
||||
text: qsTr("&Appearance")
|
||||
}
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionToolWindows
|
||||
|
||||
text: qsTr("&Tool Windows")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//
|
||||
// Help Menu
|
||||
ClideAboutWindow {
|
||||
id: clideAbout
|
||||
|
||||
}
|
||||
ClideMenu {
|
||||
title: qsTr("&Help")
|
||||
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionDocumentation
|
||||
|
||||
text: qsTr("&Documentation")
|
||||
}
|
||||
}
|
||||
ClideMenuItem {
|
||||
action: Action {
|
||||
id: actionAbout
|
||||
|
||||
text: qsTr("&About")
|
||||
|
||||
// Toggle the about window with the menu item is clicked.
|
||||
onTriggered: clideAbout.visible = !clideAbout.visible
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
22
qml/Components/ClideMenuItem.qml
Normal file
22
qml/Components/ClideMenuItem.qml
Normal file
@@ -0,0 +1,22 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls.Basic
|
||||
|
||||
import clide.module 1.0
|
||||
|
||||
MenuItem {
|
||||
id: root
|
||||
|
||||
background: Rectangle {
|
||||
color: root.hovered ? RustColors.hovered : RustColors.unhovered
|
||||
radius: 1.0
|
||||
}
|
||||
contentItem: IconLabel {
|
||||
color: "black"
|
||||
font.family: "Helvetica"
|
||||
text: root.text
|
||||
}
|
||||
}
|
||||
74
qml/Components/ClideScrollBar.qml
Normal file
74
qml/Components/ClideScrollBar.qml
Normal file
@@ -0,0 +1,74 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
|
||||
import clide.module 1.0
|
||||
|
||||
ScrollBar {
|
||||
id: scrollBar
|
||||
|
||||
// Height, opacitiy, width
|
||||
property int h: scrollBar.interactive ? sizeModifier * 2 : sizeModifier
|
||||
property int o: scrollBar.active && scrollBar.size < 1.0 ? 1.0 : 0.0
|
||||
property int sizeModifier: 4
|
||||
property int w: scrollBar.interactive ? sizeModifier * 2 : sizeModifier
|
||||
|
||||
// Scroll bar gutter
|
||||
background: Rectangle {
|
||||
id: gutter
|
||||
|
||||
color: RustColors.scrollbar_gutter
|
||||
implicitHeight: scrollBar.h
|
||||
implicitWidth: scrollBar.w
|
||||
|
||||
// Fade the scrollbar gutter when inactive.
|
||||
opacity: scrollBar.o
|
||||
radius: 20
|
||||
|
||||
Behavior on opacity {
|
||||
OpacityAnimator {
|
||||
duration: 500
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Scroll bar
|
||||
contentItem: Rectangle {
|
||||
readonly property color barColor: {
|
||||
if (scrollBar.size < 1.0) {
|
||||
// If the scrollbar is required change it's color based on activity.
|
||||
if (scrollBar.active) {
|
||||
return RustColors.scrollbar_active;
|
||||
} else {
|
||||
return RustColors.scrollbar;
|
||||
}
|
||||
} else {
|
||||
// If we don't need a scrollbar, fallback to the gutter color.
|
||||
return gutter.color;
|
||||
}
|
||||
}
|
||||
|
||||
color: barColor
|
||||
implicitHeight: scrollBar.h
|
||||
implicitWidth: scrollBar.w
|
||||
|
||||
// Fade the scrollbar when inactive.
|
||||
opacity: scrollBar.o
|
||||
radius: 20
|
||||
|
||||
// Smooth transition between color changes based on the state above.
|
||||
Behavior on color {
|
||||
ColorAnimation {
|
||||
duration: 1000
|
||||
}
|
||||
}
|
||||
Behavior on opacity {
|
||||
OpacityAnimator {
|
||||
duration: 1000
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
9
qml/Components/qmldir
Normal file
9
qml/Components/qmldir
Normal file
@@ -0,0 +1,9 @@
|
||||
ClideScrollBar ClideScrollBar.qml
|
||||
ClideHandle ClideHandle.qml
|
||||
ClideMenu ClideMenu.qml
|
||||
ClideMenuItem ClideMenuItem.qml
|
||||
ClideBreadCrumbs ClideBreadCrumbs.qml
|
||||
ClideAboutWindow ClideAboutWindow.qml
|
||||
ClideEditor ClideEditor.qml
|
||||
ClideLogger ClideLogger.qml
|
||||
ClideMenuBar ClideMenuBar.qml
|
||||
35
qml/Logger/Logger.qml
Normal file
35
qml/Logger/Logger.qml
Normal file
@@ -0,0 +1,35 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
pragma Singleton
|
||||
import QtQuick
|
||||
|
||||
QtObject {
|
||||
signal logged(string level, string message)
|
||||
|
||||
function debug(msg) {
|
||||
console.log(msg);
|
||||
logged("DEBUG", msg);
|
||||
}
|
||||
function error(msg) {
|
||||
console.error(msg);
|
||||
logged("ERROR", msg);
|
||||
}
|
||||
function info(msg) {
|
||||
console.log(msg);
|
||||
logged("INFO", msg);
|
||||
}
|
||||
function log(msg) {
|
||||
console.log(msg);
|
||||
logged("INFO", msg);
|
||||
}
|
||||
function trace(msg) {
|
||||
console.log(msg);
|
||||
logged("TRACE", msg);
|
||||
}
|
||||
function warn(msg) {
|
||||
console.warn(msg);
|
||||
logged("WARN", msg);
|
||||
}
|
||||
}
|
||||
1
qml/Logger/qmldir
Normal file
1
qml/Logger/qmldir
Normal file
@@ -0,0 +1 @@
|
||||
singleton Logger 1.0 Logger.qml
|
||||
@@ -1,10 +0,0 @@
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
|
||||
Menu {
|
||||
background: Rectangle {
|
||||
color: "#3c3f41"
|
||||
implicitWidth: 200
|
||||
radius: 2
|
||||
}
|
||||
}
|
||||
@@ -1,138 +0,0 @@
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
|
||||
MenuBar {
|
||||
background: Rectangle {
|
||||
color: "#3b3e40" // Dark background like CLion
|
||||
}
|
||||
|
||||
Action {
|
||||
id: actionNewProject
|
||||
|
||||
text: qsTr("&New Project...")
|
||||
}
|
||||
Action {
|
||||
id: actionOpen
|
||||
|
||||
text: qsTr("&Open...")
|
||||
}
|
||||
Action {
|
||||
id: actionSave
|
||||
|
||||
text: qsTr("&Save")
|
||||
}
|
||||
Action {
|
||||
id: actionExit
|
||||
|
||||
text: qsTr("&Exit")
|
||||
onTriggered: Qt.quit()
|
||||
}
|
||||
ClideMenu {
|
||||
title: qsTr("&File")
|
||||
|
||||
ClideMenuBarItem {
|
||||
action: actionNewProject
|
||||
}
|
||||
ClideMenuBarItem {
|
||||
action: actionOpen
|
||||
}
|
||||
ClideMenuBarItem {
|
||||
action: actionSave
|
||||
}
|
||||
MenuSeparator {
|
||||
background: Rectangle {
|
||||
border.color: color
|
||||
color: "#3c3f41"
|
||||
implicitHeight: 3
|
||||
implicitWidth: 200
|
||||
}
|
||||
}
|
||||
ClideMenuBarItem {
|
||||
action: actionExit
|
||||
}
|
||||
}
|
||||
Action {
|
||||
id: actionUndo
|
||||
|
||||
text: qsTr("&Undo")
|
||||
}
|
||||
Action {
|
||||
id: actionRedo
|
||||
|
||||
text: qsTr("&Redo")
|
||||
}
|
||||
Action {
|
||||
id: actionCut
|
||||
|
||||
text: qsTr("&Cut")
|
||||
}
|
||||
Action {
|
||||
id: actionCopy
|
||||
|
||||
text: qsTr("&Copy")
|
||||
}
|
||||
Action {
|
||||
id: actionPaste
|
||||
|
||||
text: qsTr("&Paste")
|
||||
}
|
||||
ClideMenu {
|
||||
title: qsTr("&Edit")
|
||||
|
||||
ClideMenuBarItem {
|
||||
action: actionUndo
|
||||
}
|
||||
ClideMenuBarItem {
|
||||
action: actionRedo
|
||||
}
|
||||
ClideMenuBarItem {
|
||||
action: actionCut
|
||||
}
|
||||
ClideMenuBarItem {
|
||||
action: actionCopy
|
||||
}
|
||||
ClideMenuBarItem {
|
||||
action: actionPaste
|
||||
}
|
||||
}
|
||||
Action {
|
||||
id: actionToolWindows
|
||||
|
||||
text: qsTr("&Tool Windows")
|
||||
}
|
||||
Action {
|
||||
id: actionAppearance
|
||||
|
||||
text: qsTr("&Appearance")
|
||||
}
|
||||
ClideMenu {
|
||||
title: qsTr("&View")
|
||||
|
||||
ClideMenuBarItem {
|
||||
action: actionToolWindows
|
||||
}
|
||||
ClideMenuBarItem {
|
||||
action: actionAppearance
|
||||
}
|
||||
}
|
||||
Action {
|
||||
id: actionDocumentation
|
||||
|
||||
text: qsTr("&Documentation")
|
||||
}
|
||||
Action {
|
||||
id: actionAbout
|
||||
|
||||
text: qsTr("&About")
|
||||
}
|
||||
ClideMenu {
|
||||
title: qsTr("&Help")
|
||||
|
||||
ClideMenuBarItem {
|
||||
action: actionDocumentation
|
||||
}
|
||||
ClideMenuBarItem {
|
||||
action: actionAbout
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
|
||||
MenuItem {
|
||||
id: root
|
||||
|
||||
background: Rectangle {
|
||||
color: root.hovered ? "#4b4f51" : "#3c3f41" // Hover effect
|
||||
radius: 2.5
|
||||
}
|
||||
contentItem: IconLabel {
|
||||
color: "white"
|
||||
font.family: "Helvetica"
|
||||
text: root.text
|
||||
}
|
||||
}
|
||||
31
qml/main.qml
31
qml/main.qml
@@ -1,12 +1,21 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
import QtQuick
|
||||
import QtQuick.Controls
|
||||
import QtQuick.Layouts
|
||||
import QtQuick.Dialogs
|
||||
|
||||
import "Menu"
|
||||
import clide.module 1.0
|
||||
|
||||
ApplicationWindow {
|
||||
id: appWindow
|
||||
|
||||
required property string appContextPath
|
||||
|
||||
height: 800
|
||||
title: "CLIDE"
|
||||
title: "Clide"
|
||||
visible: true
|
||||
width: 1200
|
||||
|
||||
@@ -14,7 +23,21 @@ ApplicationWindow {
|
||||
}
|
||||
|
||||
Rectangle {
|
||||
anchors.fill: parent
|
||||
color: "#1e1f22" // Dark background
|
||||
color: RustColors.menubar
|
||||
width: appView.implicitWidth
|
||||
height: appView.implicitHeight
|
||||
|
||||
ClideApplicationView {
|
||||
id: appView
|
||||
projectDir: appWindow.appContextPath
|
||||
implicitHeight: appWindow.height
|
||||
implicitWidth: appWindow.width
|
||||
|
||||
anchors.right: parent.right
|
||||
anchors.bottom: parent.bottom
|
||||
anchors.leftMargin: 20
|
||||
anchors.topMargin: 10
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
10
resources.qrc
Normal file
10
resources.qrc
Normal file
@@ -0,0 +1,10 @@
|
||||
<RCC>
|
||||
<qresource prefix="/images">
|
||||
<file alias="kilroy.png">resources/images/kilroy-256.png</file>
|
||||
</qresource>
|
||||
<qresource prefix="/fonts">
|
||||
<file alias="saucecodepro.ttf">resources/SauceCodeProNerdFont-Black.ttf</file>
|
||||
<file alias="saucecodepro-light.ttf">resources/SauceCodeProNerdFont-Light.ttf</file>
|
||||
<file alias="saucecodepro-xlight.ttf">resources/SauceCodeProNerdFont-ExtraLight.ttf</file>
|
||||
</qresource>
|
||||
</RCC>
|
||||
BIN
resources/SauceCodeProNerdFont-Black.ttf
Normal file
BIN
resources/SauceCodeProNerdFont-Black.ttf
Normal file
Binary file not shown.
BIN
resources/SauceCodeProNerdFont-ExtraLight.ttf
Normal file
BIN
resources/SauceCodeProNerdFont-ExtraLight.ttf
Normal file
Binary file not shown.
BIN
resources/SauceCodeProNerdFont-Light.ttf
Normal file
BIN
resources/SauceCodeProNerdFont-Light.ttf
Normal file
Binary file not shown.
BIN
resources/gui.png
Normal file
BIN
resources/gui.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 402 KiB |
BIN
resources/images/kilroy-256.png
Normal file
BIN
resources/images/kilroy-256.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
resources/tui.png
Normal file
BIN
resources/tui.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 204 KiB |
38
src/gui.rs
Normal file
38
src/gui.rs
Normal file
@@ -0,0 +1,38 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use crate::AppContext;
|
||||
use anyhow::Result;
|
||||
use cxx_qt_lib::{QMapPair, QMapPair_QString_QVariant, QString, QVariant};
|
||||
|
||||
pub mod colors;
|
||||
pub mod filesystem;
|
||||
|
||||
pub fn run(app_context: AppContext) -> Result<()> {
|
||||
libclide::trace!(target:"gui::run()", "Starting the GUI editor at {:?}", app_context.path);
|
||||
|
||||
use cxx_qt_lib::{QGuiApplication, QQmlApplicationEngine, QUrl};
|
||||
|
||||
let mut app = QGuiApplication::new();
|
||||
let mut engine = QQmlApplicationEngine::new();
|
||||
|
||||
// Set QML property for the directory provided to the CLI.
|
||||
let path = QString::from(app_context.path.to_string_lossy().to_string());
|
||||
let mut map = QMapPair_QString_QVariant::default();
|
||||
map.insert(QString::from("appContextPath"), QVariant::from(&path));
|
||||
engine.as_mut().unwrap().set_initial_properties(&map);
|
||||
|
||||
if let Some(engine) = engine.as_mut() {
|
||||
engine.add_import_path(&QString::from("qml/"));
|
||||
}
|
||||
if let Some(engine) = engine.as_mut() {
|
||||
engine.load(&QUrl::from("qml/main.qml"));
|
||||
}
|
||||
|
||||
if let Some(app) = app.as_mut() {
|
||||
app.exec();
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
115
src/gui/colors.rs
Normal file
115
src/gui/colors.rs
Normal file
@@ -0,0 +1,115 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use cxx_qt_lib::QColor;
|
||||
use libclide::theme::colors::Colors;
|
||||
|
||||
#[cxx_qt::bridge]
|
||||
pub mod qobject {
|
||||
unsafe extern "C++" {
|
||||
include!("cxx-qt-lib/qcolor.h");
|
||||
type QColor = cxx_qt_lib::QColor;
|
||||
}
|
||||
|
||||
unsafe extern "RustQt" {
|
||||
#[qobject]
|
||||
#[qml_element]
|
||||
#[qml_singleton]
|
||||
#[qproperty(QColor, hovered)]
|
||||
#[qproperty(QColor, unhovered)]
|
||||
#[qproperty(QColor, pressed)]
|
||||
#[qproperty(QColor, menubar)]
|
||||
#[qproperty(QColor, menubar_border)]
|
||||
#[qproperty(QColor, scrollbar)]
|
||||
#[qproperty(QColor, scrollbar_active)]
|
||||
#[qproperty(QColor, scrollbar_gutter)]
|
||||
#[qproperty(QColor, linenumber)]
|
||||
#[qproperty(QColor, active)]
|
||||
#[qproperty(QColor, inactive)]
|
||||
#[qproperty(QColor, editor_background)]
|
||||
#[qproperty(QColor, editor_text)]
|
||||
#[qproperty(QColor, editor_highlighted_text)]
|
||||
#[qproperty(QColor, editor_highlight)]
|
||||
#[qproperty(QColor, gutter)]
|
||||
#[qproperty(QColor, explorer_hovered)]
|
||||
#[qproperty(QColor, explorer_text)]
|
||||
#[qproperty(QColor, explorer_text_selected)]
|
||||
#[qproperty(QColor, explorer_background)]
|
||||
#[qproperty(QColor, explorer_folder)]
|
||||
#[qproperty(QColor, explorer_folder_open)]
|
||||
#[qproperty(QColor, terminal_background)]
|
||||
#[qproperty(QColor, info_log)]
|
||||
#[qproperty(QColor, debug_log)]
|
||||
#[qproperty(QColor, warn_log)]
|
||||
#[qproperty(QColor, error_log)]
|
||||
#[qproperty(QColor, trace_log)]
|
||||
type RustColors = super::RustColorsImpl;
|
||||
}
|
||||
}
|
||||
|
||||
pub struct RustColorsImpl {
|
||||
hovered: QColor,
|
||||
unhovered: QColor,
|
||||
pressed: QColor,
|
||||
menubar: QColor,
|
||||
menubar_border: QColor,
|
||||
scrollbar: QColor,
|
||||
scrollbar_active: QColor,
|
||||
scrollbar_gutter: QColor,
|
||||
linenumber: QColor,
|
||||
active: QColor,
|
||||
inactive: QColor,
|
||||
editor_background: QColor,
|
||||
editor_text: QColor,
|
||||
editor_highlighted_text: QColor,
|
||||
editor_highlight: QColor,
|
||||
gutter: QColor,
|
||||
explorer_hovered: QColor,
|
||||
explorer_text: QColor,
|
||||
explorer_text_selected: QColor,
|
||||
explorer_background: QColor,
|
||||
explorer_folder: QColor,
|
||||
explorer_folder_open: QColor,
|
||||
terminal_background: QColor,
|
||||
info_log: QColor,
|
||||
debug_log: QColor,
|
||||
warn_log: QColor,
|
||||
error_log: QColor,
|
||||
trace_log: QColor,
|
||||
}
|
||||
|
||||
impl Default for RustColorsImpl {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
hovered: QColor::try_from(Colors::HOVERED).unwrap(),
|
||||
unhovered: QColor::try_from(Colors::UNHOVERED).unwrap(),
|
||||
pressed: QColor::try_from(Colors::PRESSED).unwrap(),
|
||||
menubar: QColor::try_from(Colors::MENUBAR).unwrap(),
|
||||
menubar_border: QColor::try_from(Colors::MENUBAR_BORDER).unwrap(),
|
||||
scrollbar: QColor::try_from(Colors::SCROLLBAR).unwrap(),
|
||||
scrollbar_active: QColor::try_from(Colors::SCROLLBAR_ACTIVE).unwrap(),
|
||||
scrollbar_gutter: QColor::try_from(Colors::SCROLLBAR_GUTTER).unwrap(),
|
||||
linenumber: QColor::try_from(Colors::LINENUMBER).unwrap(),
|
||||
active: QColor::try_from(Colors::ACTIVE).unwrap(),
|
||||
inactive: QColor::try_from(Colors::INACTIVE).unwrap(),
|
||||
editor_background: QColor::try_from(Colors::EDITOR_BACKGROUND).unwrap(),
|
||||
editor_text: QColor::try_from(Colors::EDITOR_TEXT).unwrap(),
|
||||
editor_highlighted_text: QColor::try_from(Colors::EDITOR_HIGHLIGHTED_TEXT).unwrap(),
|
||||
editor_highlight: QColor::try_from(Colors::EDITOR_HIGHLIGHT).unwrap(),
|
||||
gutter: QColor::try_from(Colors::GUTTER).unwrap(),
|
||||
explorer_hovered: QColor::try_from(Colors::EXPLORER_HOVERED).unwrap(),
|
||||
explorer_text: QColor::try_from(Colors::EXPLORER_TEXT).unwrap(),
|
||||
explorer_text_selected: QColor::try_from(Colors::EXPLORER_TEXT_SELECTED).unwrap(),
|
||||
explorer_background: QColor::try_from(Colors::EXPLORER_BACKGROUND).unwrap(),
|
||||
explorer_folder: QColor::try_from(Colors::EXPLORER_FOLDER).unwrap(),
|
||||
explorer_folder_open: QColor::try_from(Colors::EXPLORER_FOLDER_OPEN).unwrap(),
|
||||
terminal_background: QColor::try_from(Colors::TERMINAL_BACKGROUND).unwrap(),
|
||||
info_log: QColor::try_from(Colors::INFO_LOG).unwrap(),
|
||||
debug_log: QColor::try_from(Colors::DEBUG_LOG).unwrap(),
|
||||
warn_log: QColor::try_from(Colors::WARN_LOG).unwrap(),
|
||||
error_log: QColor::try_from(Colors::ERROR_LOG).unwrap(),
|
||||
trace_log: QColor::try_from(Colors::TRACE_LOG).unwrap(),
|
||||
}
|
||||
}
|
||||
}
|
||||
146
src/gui/filesystem.rs
Normal file
146
src/gui/filesystem.rs
Normal file
@@ -0,0 +1,146 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use cxx_qt_lib::{QModelIndex, QString};
|
||||
use dirs;
|
||||
use std::fs;
|
||||
use std::path::Path;
|
||||
use syntect::easy::HighlightLines;
|
||||
use syntect::highlighting::ThemeSet;
|
||||
use syntect::html::{IncludeBackground, append_highlighted_html_for_styled_line};
|
||||
use syntect::parsing::SyntaxSet;
|
||||
use syntect::util::LinesWithEndings;
|
||||
|
||||
#[cxx_qt::bridge]
|
||||
pub mod qobject {
|
||||
unsafe extern "C++" {
|
||||
// Import Qt Types from C++
|
||||
include!("cxx-qt-lib/qstring.h");
|
||||
type QString = cxx_qt_lib::QString;
|
||||
include!("cxx-qt-lib/qmodelindex.h");
|
||||
type QModelIndex = cxx_qt_lib::QModelIndex;
|
||||
include!(<QtGui/QFileSystemModel>);
|
||||
type QFileSystemModel;
|
||||
}
|
||||
|
||||
unsafe extern "RustQt" {
|
||||
// Export QML Types from Rust
|
||||
#[qobject]
|
||||
#[base = QFileSystemModel]
|
||||
#[qml_element]
|
||||
#[qml_singleton]
|
||||
#[qproperty(QString, file_path, cxx_name = "filePath")]
|
||||
type FileSystem = super::FileSystemImpl;
|
||||
|
||||
#[inherit]
|
||||
#[cxx_name = "setRootPath"]
|
||||
fn set_root_path(self: Pin<&mut FileSystem>, path: &QString) -> QModelIndex;
|
||||
|
||||
#[qinvokable]
|
||||
#[cxx_override]
|
||||
#[cxx_name = "columnCount"]
|
||||
fn column_count(self: &FileSystem, _index: &QModelIndex) -> i32;
|
||||
|
||||
#[qinvokable]
|
||||
#[cxx_name = "readFile"]
|
||||
fn read_file(self: &FileSystem, path: &QString) -> QString;
|
||||
|
||||
#[qinvokable]
|
||||
#[cxx_name = "setDirectory"]
|
||||
fn set_directory(self: Pin<&mut FileSystem>, path: &QString) -> QModelIndex;
|
||||
|
||||
#[qinvokable]
|
||||
fn icon(self: Pin<&mut FileSystem>, path: &QString) -> QString;
|
||||
}
|
||||
}
|
||||
|
||||
pub struct FileSystemImpl {
|
||||
file_path: QString,
|
||||
}
|
||||
|
||||
// Default is explicit to make the editor open this source file initially.
|
||||
impl Default for FileSystemImpl {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
file_path: QString::from(file!()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl qobject::FileSystem {
|
||||
fn read_file(&self, path: &QString) -> QString {
|
||||
if path.is_empty() {
|
||||
return QString::default();
|
||||
}
|
||||
let meta = fs::metadata(path.to_string())
|
||||
.unwrap_or_else(|_| panic!("Failed to get file metadata {path:?}"));
|
||||
if !meta.is_file() {
|
||||
libclide::warn!(target:"FileSystem", "Attempted to open file {path:?} that is not a valid file");
|
||||
return QString::default();
|
||||
}
|
||||
let path_str = path.to_string();
|
||||
if let Ok(lines) = fs::read_to_string(path_str.as_str()) {
|
||||
let ss = SyntaxSet::load_defaults_nonewlines();
|
||||
let ts = ThemeSet::load_defaults();
|
||||
let theme = &ts.themes["base16-ocean.dark"];
|
||||
let lang = ss
|
||||
.find_syntax_by_extension(
|
||||
Path::new(path_str.as_str())
|
||||
.extension()
|
||||
.map(|s| s.to_str())
|
||||
.unwrap_or_else(|| Some("md"))
|
||||
.expect("Failed to get file extension"),
|
||||
)
|
||||
.unwrap_or_else(|| ss.find_syntax_plain_text());
|
||||
let mut highlighter = HighlightLines::new(lang, theme);
|
||||
// If you care about the background, see `start_highlighted_html_snippet(theme);`.
|
||||
let mut output = String::from("<pre>\n");
|
||||
for line in LinesWithEndings::from(lines.as_str()) {
|
||||
let regions = highlighter
|
||||
.highlight_line(line, &ss)
|
||||
.expect("Failed to highlight");
|
||||
|
||||
append_highlighted_html_for_styled_line(
|
||||
®ions[..],
|
||||
IncludeBackground::No,
|
||||
&mut output,
|
||||
)
|
||||
.expect("Failed to insert highlighted html");
|
||||
}
|
||||
|
||||
output.push_str("</pre>\n");
|
||||
QString::from(output)
|
||||
} else {
|
||||
QString::default()
|
||||
}
|
||||
}
|
||||
|
||||
// There will never be more than one column.
|
||||
fn column_count(&self, _index: &QModelIndex) -> i32 {
|
||||
1
|
||||
}
|
||||
|
||||
fn set_directory(self: std::pin::Pin<&mut Self>, path: &QString) -> QModelIndex {
|
||||
if !path.is_empty()
|
||||
&& fs::metadata(path.to_string())
|
||||
.unwrap_or_else(|_| panic!("Failed to get metadata for path {path:?}"))
|
||||
.is_dir()
|
||||
{
|
||||
self.set_root_path(path)
|
||||
} else {
|
||||
// If the initial directory can't be opened, attempt to find the home directory.
|
||||
let homedir = dirs::home_dir()
|
||||
.expect("Failed to get home directory")
|
||||
.as_path()
|
||||
.to_str()
|
||||
.unwrap()
|
||||
.to_string();
|
||||
self.set_root_path(&QString::from(homedir))
|
||||
}
|
||||
}
|
||||
|
||||
fn icon(self: std::pin::Pin<&mut Self>, path: &QString) -> QString {
|
||||
QString::from(libclide::fs::icon(path.to_string().as_str()).to_string())
|
||||
}
|
||||
}
|
||||
151
src/main.rs
151
src/main.rs
@@ -1,90 +1,93 @@
|
||||
// SPDX-FileCopyrightText: 2025 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
|
||||
// SPDX-FileContributor: Leon Matthes <leon.matthes@kdab.com>
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: MIT OR Apache-2.0
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
#[cxx_qt::bridge]
|
||||
mod qobject {
|
||||
unsafe extern "C++" {
|
||||
include!("cxx-qt-lib/qstring.h");
|
||||
type QString = cxx_qt_lib::QString;
|
||||
use anyhow::{Context, Result, anyhow};
|
||||
use clap::Parser;
|
||||
use std::process::{Command, Stdio};
|
||||
|
||||
pub mod gui;
|
||||
pub mod tui;
|
||||
/// 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.
|
||||
#[derive(Parser, Debug)]
|
||||
#[structopt(name = "clide", verbatim_doc_comment)]
|
||||
struct Cli {
|
||||
/// The root directory for the project to open with the clide editor.
|
||||
#[arg(value_parser = clap::value_parser!(std::path::PathBuf))]
|
||||
pub path: Option<std::path::PathBuf>,
|
||||
|
||||
/// Run clide in headless mode.
|
||||
#[arg(value_name = "tui", short, long)]
|
||||
pub tui: bool,
|
||||
|
||||
/// Run the clide GUI in the current process, blocking the terminal and showing all output streams.
|
||||
#[arg(value_name = "gui", short, long)]
|
||||
pub gui: bool,
|
||||
}
|
||||
|
||||
#[qenum(Greeter)]
|
||||
pub enum Language {
|
||||
English,
|
||||
German,
|
||||
French,
|
||||
}
|
||||
|
||||
#[qenum(Greeter)]
|
||||
pub enum Greeting {
|
||||
Hello,
|
||||
Bye,
|
||||
}
|
||||
|
||||
unsafe extern "RustQt" {
|
||||
#[qobject]
|
||||
#[qml_element]
|
||||
#[qproperty(Greeting, greeting)]
|
||||
#[qproperty(Language, language)]
|
||||
type Greeter = super::GreeterRust;
|
||||
|
||||
#[qinvokable]
|
||||
fn greet(self: &Greeter) -> QString;
|
||||
}
|
||||
}
|
||||
|
||||
use qobject::*;
|
||||
|
||||
impl Greeting {
|
||||
fn translate(&self, language: Language) -> String {
|
||||
match (self, language) {
|
||||
(&Greeting::Hello, Language::English) => "Hello, World!",
|
||||
(&Greeting::Hello, Language::German) => "Hallo, Welt!",
|
||||
(&Greeting::Hello, Language::French) => "Bonjour, le monde!",
|
||||
(&Greeting::Bye, Language::English) => "Bye!",
|
||||
(&Greeting::Bye, Language::German) => "Auf Wiedersehen!",
|
||||
(&Greeting::Bye, Language::French) => "Au revoir!",
|
||||
_ => "🤯",
|
||||
}
|
||||
.to_string()
|
||||
}
|
||||
}
|
||||
|
||||
pub struct GreeterRust {
|
||||
greeting: Greeting,
|
||||
language: Language,
|
||||
}
|
||||
|
||||
impl Default for GreeterRust {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
greeting: Greeting::Hello,
|
||||
language: Language::English,
|
||||
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."
|
||||
)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
use cxx_qt_lib::QString;
|
||||
pub struct AppContext {
|
||||
pub path: std::path::PathBuf,
|
||||
pub run_mode: RunMode,
|
||||
}
|
||||
|
||||
impl qobject::Greeter {
|
||||
fn greet(&self) -> QString {
|
||||
QString::from(self.greeting.translate(self.language))
|
||||
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")?,
|
||||
};
|
||||
libclide::info!(target:"main()", "Root path detected: {path:?}");
|
||||
|
||||
Ok(Self {
|
||||
path,
|
||||
run_mode: cli.run_mode()?,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
fn main() {
|
||||
use cxx_qt_lib::{QGuiApplication, QQmlApplicationEngine, QUrl};
|
||||
|
||||
let mut app = QGuiApplication::new();
|
||||
let mut engine = QQmlApplicationEngine::new();
|
||||
|
||||
if let Some(engine) = engine.as_mut() {
|
||||
engine.load(&QUrl::from("qml/main.qml"));
|
||||
#[derive(Copy, Clone, Debug, Default)]
|
||||
pub enum RunMode {
|
||||
#[default]
|
||||
Gui,
|
||||
GuiAttached,
|
||||
Tui,
|
||||
}
|
||||
|
||||
if let Some(app) = app.as_mut() {
|
||||
app.exec();
|
||||
fn main() -> Result<()> {
|
||||
let args = Cli::parse();
|
||||
let app_context = AppContext::new(args)?;
|
||||
match app_context.run_mode {
|
||||
RunMode::GuiAttached => gui::run(app_context),
|
||||
RunMode::Tui => tui::run(app_context),
|
||||
RunMode::Gui => {
|
||||
libclide::trace!(target:"main()", "Starting GUI in a new process");
|
||||
Command::new(std::env::current_exe()?)
|
||||
.args(["--gui", app_context.path.to_str().unwrap()])
|
||||
.stdout(Stdio::null())
|
||||
.stderr(Stdio::null())
|
||||
.stdin(Stdio::null())
|
||||
.spawn()
|
||||
.context("Failed to start GUI")
|
||||
.map(|_| ())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
95
src/tui.rs
Normal file
95
src/tui.rs
Normal file
@@ -0,0 +1,95 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
mod about;
|
||||
mod app;
|
||||
mod component;
|
||||
mod editor;
|
||||
mod editor_tab;
|
||||
mod explorer;
|
||||
mod logger;
|
||||
mod menu_bar;
|
||||
|
||||
use crate::AppContext;
|
||||
use anyhow::{Context, Result};
|
||||
use libclide_macros::Loggable;
|
||||
use log::LevelFilter;
|
||||
use ratatui::Terminal;
|
||||
use ratatui::backend::CrosstermBackend;
|
||||
use ratatui::crossterm::event::{
|
||||
DisableBracketedPaste, DisableMouseCapture, EnableBracketedPaste, EnableMouseCapture,
|
||||
};
|
||||
use ratatui::crossterm::terminal::{
|
||||
EnterAlternateScreen, LeaveAlternateScreen, disable_raw_mode, enable_raw_mode,
|
||||
};
|
||||
use std::env;
|
||||
use std::io::{Stdout, stdout};
|
||||
use tui_logger::{
|
||||
TuiLoggerFile, TuiLoggerLevelOutput, init_logger, set_default_level, set_log_file,
|
||||
};
|
||||
|
||||
#[derive(Loggable)]
|
||||
struct Tui {
|
||||
terminal: Terminal<CrosstermBackend<Stdout>>,
|
||||
root_path: std::path::PathBuf,
|
||||
}
|
||||
|
||||
pub fn run(app_context: AppContext) -> Result<()> {
|
||||
libclide::trace!(target: "clide::tui::run", "Starting TUI");
|
||||
Tui::new(app_context)?.start()
|
||||
}
|
||||
|
||||
impl Tui {
|
||||
fn new(app_context: AppContext) -> Result<Self> {
|
||||
init_logger(LevelFilter::Trace)?;
|
||||
set_default_level(LevelFilter::Trace);
|
||||
libclide::debug!("Logging initialized");
|
||||
|
||||
let mut dir = env::temp_dir();
|
||||
dir.push("clide.log");
|
||||
let file_options = TuiLoggerFile::new(
|
||||
dir.to_str()
|
||||
.context("Failed to set temp directory for file logging")?,
|
||||
)
|
||||
.output_level(Some(TuiLoggerLevelOutput::Abbreviated))
|
||||
.output_file(false)
|
||||
.output_separator(':');
|
||||
set_log_file(file_options);
|
||||
libclide::debug!("Logging to file: {dir:?}");
|
||||
|
||||
Ok(Self {
|
||||
terminal: Terminal::new(CrosstermBackend::new(stdout()))?,
|
||||
root_path: app_context.path,
|
||||
})
|
||||
}
|
||||
|
||||
fn start(self) -> Result<()> {
|
||||
libclide::info!("Starting the TUI editor at {:?}", self.root_path);
|
||||
ratatui::crossterm::execute!(
|
||||
stdout(),
|
||||
EnterAlternateScreen,
|
||||
EnableMouseCapture,
|
||||
EnableBracketedPaste
|
||||
)?;
|
||||
enable_raw_mode()?;
|
||||
|
||||
let app_result = app::App::new(self.root_path)?
|
||||
.run(self.terminal)
|
||||
.context("Failed to start the TUI editor.");
|
||||
Self::stop()?;
|
||||
app_result
|
||||
}
|
||||
|
||||
fn stop() -> Result<()> {
|
||||
libclide::info!("Stopping the TUI editor");
|
||||
disable_raw_mode()?;
|
||||
ratatui::crossterm::execute!(
|
||||
stdout(),
|
||||
LeaveAlternateScreen,
|
||||
DisableMouseCapture,
|
||||
DisableBracketedPaste
|
||||
)?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
91
src/tui/about.rs
Normal file
91
src/tui/about.rs
Normal file
@@ -0,0 +1,91 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use libclide_macros::Loggable;
|
||||
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};
|
||||
|
||||
#[derive(Loggable)]
|
||||
pub struct About {}
|
||||
|
||||
impl About {
|
||||
pub fn new() -> Self {
|
||||
// libclide::trace!("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.render(kilroy_rect, buf);
|
||||
Clear.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);
|
||||
}
|
||||
}
|
||||
393
src/tui/app.rs
Normal file
393
src/tui/app.rs
Normal file
@@ -0,0 +1,393 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use crate::tui::about::About;
|
||||
use crate::tui::component::{Action, Component, Focus, FocusState, Visibility, VisibleState};
|
||||
use crate::tui::editor_tab::EditorTab;
|
||||
use crate::tui::explorer::Explorer;
|
||||
use crate::tui::logger::Logger;
|
||||
use crate::tui::menu_bar::MenuBar;
|
||||
use anyhow::{Context, Result};
|
||||
use libclide::log::Loggable;
|
||||
use libclide_macros::Loggable;
|
||||
use ratatui::DefaultTerminal;
|
||||
use ratatui::buffer::Buffer;
|
||||
use ratatui::crossterm::event;
|
||||
use ratatui::crossterm::event::{
|
||||
Event, KeyCode, KeyEvent, KeyEventKind, KeyModifiers, MouseButton, MouseEventKind,
|
||||
};
|
||||
use ratatui::layout::{Constraint, Direction, Layout, Rect};
|
||||
use ratatui::prelude::{Color, Widget};
|
||||
use ratatui::widgets::{Paragraph, Wrap};
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::time::Duration;
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq)]
|
||||
pub enum AppComponent {
|
||||
Editor,
|
||||
Explorer,
|
||||
Logger,
|
||||
MenuBar,
|
||||
}
|
||||
|
||||
#[derive(Loggable)]
|
||||
pub struct App<'a> {
|
||||
editor_tab: EditorTab,
|
||||
explorer: Explorer<'a>,
|
||||
logger: Logger,
|
||||
menu_bar: MenuBar,
|
||||
last_active: AppComponent,
|
||||
about: bool,
|
||||
}
|
||||
|
||||
impl<'a> App<'a> {
|
||||
pub fn new(root_path: PathBuf) -> Result<Self> {
|
||||
libclide::trace!("Building {}", <Self as Loggable>::ID);
|
||||
let app = Self {
|
||||
editor_tab: EditorTab::new(),
|
||||
explorer: Explorer::new(&root_path)?,
|
||||
logger: Logger::new(),
|
||||
menu_bar: MenuBar::new(),
|
||||
last_active: AppComponent::Editor,
|
||||
about: false,
|
||||
};
|
||||
Ok(app)
|
||||
}
|
||||
|
||||
/// Logic that should be executed once on application startup.
|
||||
pub fn start(&mut self) -> Result<()> {
|
||||
libclide::trace!("Starting App");
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn run(mut self, mut terminal: DefaultTerminal) -> Result<()> {
|
||||
self.start()?;
|
||||
libclide::trace!("Entering App run loop");
|
||||
loop {
|
||||
terminal.draw(|f| {
|
||||
f.render_widget(&mut self, f.area());
|
||||
})?;
|
||||
|
||||
if event::poll(Duration::from_millis(250)).context("event poll failed")? {
|
||||
match self.handle_event(event::read()?)? {
|
||||
Action::Quit => break,
|
||||
Action::Handled => {}
|
||||
_ => {
|
||||
// bail!("Unhandled event: {:?}", event);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn draw_bottom_status(&self, area: Rect, buf: &mut Buffer) {
|
||||
// Determine help text from the most recently focused component.
|
||||
let help = match self.last_active {
|
||||
AppComponent::Editor => match self.editor_tab.current_editor() {
|
||||
Some(editor) => editor.component_state.help_text.clone(),
|
||||
None => {
|
||||
if !self.editor_tab.is_empty() {
|
||||
libclide::error!("Failed to get Editor while drawing bottom status bar");
|
||||
}
|
||||
"Failed to get current Editor while getting widget help text".to_string()
|
||||
}
|
||||
},
|
||||
AppComponent::Explorer => self.explorer.component_state.help_text.clone(),
|
||||
AppComponent::Logger => self.logger.component_state.help_text.clone(),
|
||||
AppComponent::MenuBar => self.menu_bar.component_state.help_text.clone(),
|
||||
};
|
||||
Paragraph::new(
|
||||
concat!(
|
||||
"ALT+Q: Focus project explorer | ALT+W: Focus editor | ALT+E: Focus logger |",
|
||||
" ALT+R: Focus menu bar | CTRL+C: Quit\n"
|
||||
)
|
||||
.to_string()
|
||||
+ help.as_str(),
|
||||
)
|
||||
.style(Color::Gray)
|
||||
.wrap(Wrap { trim: false })
|
||||
.centered()
|
||||
.render(area, buf);
|
||||
}
|
||||
|
||||
fn clear_focus(&mut self) {
|
||||
libclide::info!("Clearing all widget focus");
|
||||
self.explorer.component_state.set_focus(Focus::Inactive);
|
||||
self.explorer.component_state.set_focus(Focus::Inactive);
|
||||
self.logger.component_state.set_focus(Focus::Inactive);
|
||||
self.menu_bar.component_state.set_focus(Focus::Inactive);
|
||||
match self.editor_tab.current_editor_mut() {
|
||||
None => {
|
||||
libclide::error!("Failed to get current Editor while clearing focus")
|
||||
}
|
||||
Some(editor) => editor.component_state.set_focus(Focus::Inactive),
|
||||
}
|
||||
}
|
||||
|
||||
fn change_focus(&mut self, focus: AppComponent) {
|
||||
libclide::info!("Changing widget focus to {:?}", focus);
|
||||
self.clear_focus();
|
||||
match focus {
|
||||
AppComponent::Editor => match self.editor_tab.current_editor_mut() {
|
||||
None => {
|
||||
libclide::error!("Failed to get current Editor while changing focus")
|
||||
}
|
||||
Some(editor) => editor.component_state.set_focus(Focus::Active),
|
||||
},
|
||||
AppComponent::Explorer => self.explorer.component_state.set_focus(Focus::Active),
|
||||
AppComponent::Logger => self.logger.component_state.set_focus(Focus::Active),
|
||||
AppComponent::MenuBar => self.menu_bar.component_state.set_focus(Focus::Active),
|
||||
}
|
||||
self.last_active = focus;
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> Widget for &mut App<'a> {
|
||||
fn render(self, area: Rect, buf: &mut Buffer)
|
||||
where
|
||||
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()
|
||||
.direction(Direction::Vertical)
|
||||
.constraints(vertical_constraints)
|
||||
.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()
|
||||
.direction(Direction::Horizontal)
|
||||
.constraints(horizontal_constraints)
|
||||
.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 {
|
||||
// Index 1 of vertical is rendered with the horizontal layout above.
|
||||
Visibility::Visible => {
|
||||
self.logger.render(vertical[2], buf);
|
||||
self.draw_bottom_status(vertical[3], buf);
|
||||
// The title bar is rendered last to overlay any popups created for drop-down menus.
|
||||
self.menu_bar.render(vertical[0], buf);
|
||||
}
|
||||
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 {
|
||||
let about_area = area.centered(Constraint::Percentage(40), Constraint::Percentage(50));
|
||||
About::new().render(about_area, buf);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> Component for App<'a> {
|
||||
/// Handles events for the App and delegates to attached Components.
|
||||
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
||||
// Handle events in the primary application.
|
||||
if let Some(key_event) = event.as_key_event() {
|
||||
let res = self
|
||||
.handle_key_events(key_event)
|
||||
.context("Failed to handle key events for primary App Component.");
|
||||
match res {
|
||||
Ok(Action::Quit) | Ok(Action::Handled) => return res,
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
// Handle events for all components.
|
||||
let action = match self.last_active {
|
||||
AppComponent::Editor => self.editor_tab.handle_event(event.clone())?,
|
||||
AppComponent::Explorer => self.explorer.handle_event(event.clone())?,
|
||||
AppComponent::Logger => self.logger.handle_event(event.clone())?,
|
||||
AppComponent::MenuBar => self.menu_bar.handle_event(event.clone())?,
|
||||
};
|
||||
|
||||
// Components should always handle mouse events for click interaction.
|
||||
if let Some(mouse) = event.as_mouse_event()
|
||||
&& mouse.kind == MouseEventKind::Down(MouseButton::Left)
|
||||
{
|
||||
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)?;
|
||||
}
|
||||
|
||||
// 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 => {
|
||||
libclide::error!(
|
||||
"Failed to get current editor while handling App Action::Save"
|
||||
);
|
||||
Ok(Action::Noop)
|
||||
}
|
||||
Some(editor) => match editor.save() {
|
||||
Ok(_) => Ok(Action::Handled),
|
||||
Err(e) => {
|
||||
libclide::error!("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 => {
|
||||
libclide::trace!("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 {
|
||||
libclide::error!(
|
||||
"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.
|
||||
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 {
|
||||
KeyEvent {
|
||||
code: KeyCode::Char('q'),
|
||||
modifiers: KeyModifiers::ALT,
|
||||
kind: KeyEventKind::Press,
|
||||
state: _state,
|
||||
} => {
|
||||
self.change_focus(AppComponent::Explorer);
|
||||
Ok(Action::Handled)
|
||||
}
|
||||
KeyEvent {
|
||||
code: KeyCode::Char('w'),
|
||||
modifiers: KeyModifiers::ALT,
|
||||
kind: KeyEventKind::Press,
|
||||
state: _state,
|
||||
} => {
|
||||
self.change_focus(AppComponent::Editor);
|
||||
Ok(Action::Handled)
|
||||
}
|
||||
KeyEvent {
|
||||
code: KeyCode::Char('e'),
|
||||
modifiers: KeyModifiers::ALT,
|
||||
kind: KeyEventKind::Press,
|
||||
state: _state,
|
||||
} => {
|
||||
self.change_focus(AppComponent::Logger);
|
||||
Ok(Action::Handled)
|
||||
}
|
||||
KeyEvent {
|
||||
code: KeyCode::Char('r'),
|
||||
modifiers: KeyModifiers::ALT,
|
||||
kind: KeyEventKind::Press,
|
||||
state: _state,
|
||||
} => {
|
||||
self.change_focus(AppComponent::MenuBar);
|
||||
Ok(Action::Handled)
|
||||
}
|
||||
KeyEvent {
|
||||
code: KeyCode::Char('c'),
|
||||
modifiers: KeyModifiers::CONTROL,
|
||||
kind: KeyEventKind::Press,
|
||||
state: _state,
|
||||
} => Ok(Action::Quit),
|
||||
_ => Ok(Action::Noop),
|
||||
}
|
||||
}
|
||||
}
|
||||
172
src/tui/component.rs
Normal file
172
src/tui/component.rs
Normal file
@@ -0,0 +1,172 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
#![allow(dead_code, unused_variables)]
|
||||
|
||||
use crate::tui::component::Focus::Inactive;
|
||||
use Focus::Active;
|
||||
use anyhow::Result;
|
||||
use libclide::theme::colors::Colors;
|
||||
use libclide_macros::Loggable;
|
||||
use ratatui::crossterm::event::{Event, KeyEvent, MouseEvent};
|
||||
use ratatui::style::Color;
|
||||
|
||||
pub enum Action {
|
||||
/// Exit the application.
|
||||
Quit,
|
||||
|
||||
/// The input was checked by the Component and had no effect.
|
||||
Noop,
|
||||
|
||||
/// Pass input to another component or external handler.
|
||||
/// Similar to Noop with the added context that externally handled input may have had an impact.
|
||||
Pass,
|
||||
|
||||
/// Save the current file.
|
||||
Save,
|
||||
|
||||
/// The input was handled by a Component and should not be passed to the next component.
|
||||
Handled,
|
||||
OpenTab,
|
||||
ReloadFile,
|
||||
ShowHideExplorer,
|
||||
ShowHideLogger,
|
||||
ShowHideAbout,
|
||||
CloseTab,
|
||||
}
|
||||
|
||||
pub trait Component {
|
||||
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
||||
match event {
|
||||
Event::Key(key_event) => self.handle_key_events(key_event),
|
||||
_ => Ok(Action::Noop),
|
||||
}
|
||||
}
|
||||
|
||||
fn handle_key_events(&mut self, key: KeyEvent) -> Result<Action> {
|
||||
Ok(Action::Noop)
|
||||
}
|
||||
|
||||
fn handle_mouse_events(&mut self, mouse: MouseEvent) -> Result<Action> {
|
||||
Ok(Action::Noop)
|
||||
}
|
||||
|
||||
fn update(&mut self, action: Action) -> Result<Action> {
|
||||
Ok(Action::Noop)
|
||||
}
|
||||
|
||||
/// Override this method for creating components that conditionally handle input.
|
||||
fn is_active(&self) -> bool {
|
||||
true
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Default, Loggable)]
|
||||
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 {
|
||||
libclide::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::from_u32(Colors::css_to_u32(Colors::ACTIVE)),
|
||||
Inactive => Color::from_u32(Colors::css_to_u32(Colors::INACTIVE)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
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),
|
||||
}
|
||||
}
|
||||
}
|
||||
146
src/tui/editor.rs
Normal file
146
src/tui/editor.rs
Normal file
@@ -0,0 +1,146 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use crate::tui::component::{Action, Component, ComponentState, Focus, FocusState};
|
||||
use anyhow::{Context, Result, bail};
|
||||
use edtui::{
|
||||
EditorEventHandler, EditorState, EditorTheme, EditorView, LineNumbers, Lines, SyntaxHighlighter,
|
||||
};
|
||||
use libclide::log::Loggable;
|
||||
use libclide_macros::Loggable;
|
||||
use ratatui::buffer::Buffer;
|
||||
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent, KeyModifiers};
|
||||
use ratatui::layout::{Alignment, Rect};
|
||||
use ratatui::prelude::{Color, Style};
|
||||
use ratatui::widgets::{Block, Borders, Padding, Widget};
|
||||
use std::path::PathBuf;
|
||||
use syntect::parsing::SyntaxSet;
|
||||
|
||||
#[derive(Loggable)]
|
||||
pub struct Editor {
|
||||
pub state: EditorState,
|
||||
pub event_handler: EditorEventHandler,
|
||||
pub file_path: Option<PathBuf>,
|
||||
syntax_set: SyntaxSet,
|
||||
pub(crate) component_state: ComponentState,
|
||||
}
|
||||
|
||||
impl Editor {
|
||||
pub fn new(path: &std::path::Path) -> Self {
|
||||
libclide::trace!("Building {}", <Self as Loggable>::ID);
|
||||
Editor {
|
||||
state: EditorState::default(),
|
||||
event_handler: EditorEventHandler::default(),
|
||||
file_path: Some(path.to_owned()),
|
||||
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<()> {
|
||||
libclide::trace!("Reloading editor file contents {:?}", self.file_path);
|
||||
match self.file_path.clone() {
|
||||
None => {
|
||||
libclide::error!("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<()> {
|
||||
libclide::trace!("Setting Editor contents from path {:?}", path);
|
||||
if let Ok(contents) = std::fs::read_to_string(path) {
|
||||
let lines: Vec<_> = contents
|
||||
.lines()
|
||||
.map(|line| line.chars().collect::<Vec<char>>())
|
||||
.collect();
|
||||
self.file_path = Some(PathBuf::from(path));
|
||||
self.state.lines = Lines::new(lines);
|
||||
self.state.cursor.row = 0;
|
||||
self.state.cursor.col = 0;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn save(&self) -> Result<()> {
|
||||
if let Some(path) = &self.file_path {
|
||||
libclide::trace!("Saving Editor contents {:?}", path);
|
||||
return std::fs::write(path, self.state.lines.to_string()).map_err(|e| e.into());
|
||||
};
|
||||
libclide::error!("Failed saving Editor contents; file_path was None");
|
||||
bail!("File not saved. No file path set.")
|
||||
}
|
||||
}
|
||||
|
||||
impl Widget for &mut Editor {
|
||||
fn render(self, area: Rect, buf: &mut Buffer) {
|
||||
let lang = self
|
||||
.file_path
|
||||
.as_ref()
|
||||
.and_then(|p| p.extension())
|
||||
.map(|e| e.to_str().unwrap_or("md"))
|
||||
.unwrap_or("md");
|
||||
let lang_name = self
|
||||
.syntax_set
|
||||
.find_syntax_by_extension(lang)
|
||||
.map(|s| s.name.to_string())
|
||||
.unwrap_or_else(|| String::from("Unknown"));
|
||||
|
||||
EditorView::new(&mut self.state)
|
||||
.wrap(true)
|
||||
.theme(
|
||||
EditorTheme::default().block(
|
||||
Block::default()
|
||||
.title(lang_name.to_owned())
|
||||
.title_style(Style::default().fg(Color::Yellow))
|
||||
.title_alignment(Alignment::Right)
|
||||
.borders(Borders::ALL)
|
||||
.padding(Padding::new(0, 0, 0, 1))
|
||||
.style(Style::default().fg(self.component_state.get_active_color())),
|
||||
),
|
||||
)
|
||||
.syntax_highlighter(SyntaxHighlighter::new("dracula", lang).ok())
|
||||
.tab_width(2)
|
||||
.line_numbers(LineNumbers::Absolute)
|
||||
.render(area, buf);
|
||||
}
|
||||
}
|
||||
|
||||
impl Component for Editor {
|
||||
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
||||
if let Some(key_event) = event.as_key_event() {
|
||||
// Handle events here that should not be passed on to the vim emulation handler.
|
||||
if let Action::Handled = self.handle_key_events(key_event)? {
|
||||
return Ok(Action::Handled);
|
||||
}
|
||||
}
|
||||
self.event_handler.on_event(event, &mut self.state);
|
||||
Ok(Action::Pass)
|
||||
}
|
||||
|
||||
/// The events for the vim emulation should be handled by EditorEventHandler::on_event.
|
||||
/// These events are custom to the clide application.
|
||||
fn handle_key_events(&mut self, key: KeyEvent) -> Result<Action> {
|
||||
match key {
|
||||
KeyEvent {
|
||||
code: KeyCode::Char('s'),
|
||||
modifiers: KeyModifiers::CONTROL,
|
||||
..
|
||||
} => {
|
||||
self.save().context("Failed to save file.")?;
|
||||
Ok(Action::Handled)
|
||||
}
|
||||
// For other events not handled here, pass to the vim emulation handler.
|
||||
_ => Ok(Action::Noop),
|
||||
}
|
||||
}
|
||||
|
||||
fn is_active(&self) -> bool {
|
||||
self.component_state.focus == Focus::Active
|
||||
}
|
||||
}
|
||||
247
src/tui/editor_tab.rs
Normal file
247
src/tui/editor_tab.rs
Normal file
@@ -0,0 +1,247 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use crate::tui::component::{Action, Component, Focus, FocusState};
|
||||
use crate::tui::editor::Editor;
|
||||
use anyhow::{Context, Result, anyhow};
|
||||
use libclide::log::Loggable;
|
||||
use libclide_macros::Loggable;
|
||||
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
|
||||
#[derive(Loggable)]
|
||||
pub struct EditorTab {
|
||||
pub(crate) editors: HashMap<String, Editor>,
|
||||
tab_order: Vec<String>,
|
||||
current_editor: usize,
|
||||
}
|
||||
|
||||
impl EditorTab {
|
||||
pub fn new() -> Self {
|
||||
libclide::trace!("Building {}", <Self as Loggable>::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();
|
||||
libclide::trace!(
|
||||
"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);
|
||||
libclide::trace!(
|
||||
"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() {
|
||||
libclide::error!("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) {
|
||||
libclide::trace!(
|
||||
"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) {
|
||||
libclide::trace!("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.
|
||||
libclide::trace!(
|
||||
"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 => {
|
||||
libclide::error!("Failed setting tab focus for invalid key {index}");
|
||||
}
|
||||
Some(key) => match self.editors.get_mut(&key) {
|
||||
None => {
|
||||
libclide::error!(
|
||||
"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<()> {
|
||||
libclide::trace!("Opening new EditorTab with path {:?}", path);
|
||||
if self
|
||||
.editors
|
||||
.contains_key(&path.to_string_lossy().to_string())
|
||||
{
|
||||
libclide::warn!("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 => {
|
||||
libclide::error!("Failed to remove editor tab {key} with invalid index {index}")
|
||||
}
|
||||
Some(_) => {
|
||||
self.prev_editor();
|
||||
self.tab_order.remove(index);
|
||||
libclide::info!("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),
|
||||
}
|
||||
}
|
||||
}
|
||||
187
src/tui/explorer.rs
Normal file
187
src/tui/explorer.rs
Normal file
@@ -0,0 +1,187 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use crate::tui::component::{Action, Component, ComponentState, Focus, FocusState};
|
||||
use anyhow::{Context, Result, bail};
|
||||
use libclide::fs::entry_meta::EntryMeta;
|
||||
use libclide::log::Loggable;
|
||||
use libclide_macros::Loggable;
|
||||
use ratatui::buffer::Buffer;
|
||||
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent, MouseEvent, MouseEventKind};
|
||||
use ratatui::layout::{Alignment, Position, Rect};
|
||||
use ratatui::prelude::Style;
|
||||
use ratatui::style::{Color, Modifier};
|
||||
use ratatui::widgets::{Block, Borders, StatefulWidget, Widget};
|
||||
use std::fs;
|
||||
use std::path::{Path, PathBuf};
|
||||
use tui_tree_widget::{Tree, TreeItem, TreeState};
|
||||
|
||||
#[derive(Debug, Loggable)]
|
||||
pub struct Explorer<'a> {
|
||||
root_path: EntryMeta,
|
||||
tree_items: TreeItem<'a, String>,
|
||||
tree_state: TreeState<String>,
|
||||
pub(crate) component_state: ComponentState,
|
||||
}
|
||||
|
||||
impl<'a> Explorer<'a> {
|
||||
pub fn new(path: &PathBuf) -> Result<Self> {
|
||||
libclide::trace!("Building {}", <Self as Loggable>::ID);
|
||||
let explorer = Explorer {
|
||||
root_path: EntryMeta::new(path)?,
|
||||
tree_items: Self::build_tree_from_path(path)?,
|
||||
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)
|
||||
}
|
||||
|
||||
/// Builds the file tree from a path using recursion.
|
||||
/// The identifiers used for the TreeItems are normalized. Symlinks are not resolved.
|
||||
/// Resolving symlinks would cause collisions on the TreeItem unique identifiers within the set.
|
||||
fn build_tree_from_path<P: AsRef<Path>>(p: P) -> Result<TreeItem<'static, String>> {
|
||||
let path = p.as_ref();
|
||||
let mut children = vec![];
|
||||
let path_meta = EntryMeta::new(path)?;
|
||||
if let Ok(entries) = fs::read_dir(&path_meta.abs_path) {
|
||||
let mut paths = entries
|
||||
.map(|res| res.map(|e| e.path()))
|
||||
.collect::<Result<Vec<_>, std::io::Error>>()
|
||||
.context(format!(
|
||||
"Failed to build vector of paths under directory: {:?}",
|
||||
&path_meta.abs_path
|
||||
))?;
|
||||
paths.sort();
|
||||
for entry_path in paths {
|
||||
let entry_meta = EntryMeta::new(&entry_path)?;
|
||||
if entry_meta.is_dir {
|
||||
children.push(Self::build_tree_from_path(&entry_meta.abs_path)?);
|
||||
} else {
|
||||
children.push(TreeItem::new_leaf(
|
||||
entry_meta.abs_path.clone(),
|
||||
format!("{} {}", entry_meta.icon.icon, entry_meta.file_name.as_str()),
|
||||
));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Note: The first argument is a unique identifier, where no. 2 TreeItems may share the same.
|
||||
// For a file tree this is fine because we shouldn't list the same object twice.
|
||||
TreeItem::new(
|
||||
path_meta.abs_path.clone(),
|
||||
format!("{} {}", path_meta.icon.icon, path_meta.file_name.as_str()),
|
||||
children,
|
||||
)
|
||||
.context(format!(
|
||||
"Failed to build tree from path: {:?}",
|
||||
path_meta.abs_path
|
||||
))
|
||||
}
|
||||
|
||||
pub fn selected(&self) -> Result<String> {
|
||||
if let Some(path) = self.tree_state.selected().last() {
|
||||
return Ok(std::path::absolute(path)?
|
||||
.to_str()
|
||||
.context("Failed to get absolute path to selected TreeItem")?
|
||||
.to_string());
|
||||
}
|
||||
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()) {
|
||||
StatefulWidget::render(
|
||||
tree.block(
|
||||
Block::default()
|
||||
.borders(Borders::ALL)
|
||||
.title(self.root_path.file_name.clone())
|
||||
.border_style(Style::default().fg(self.component_state.get_active_color()))
|
||||
.title_style(Style::default().fg(Color::Green))
|
||||
.title_alignment(Alignment::Center),
|
||||
)
|
||||
.highlight_style(
|
||||
Style::new()
|
||||
.fg(Color::Black)
|
||||
.bg(Color::Rgb(57, 59, 64))
|
||||
.add_modifier(Modifier::BOLD),
|
||||
),
|
||||
area,
|
||||
buf,
|
||||
&mut self.tree_state,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> Component for Explorer<'a> {
|
||||
fn handle_event(&mut self, event: Event) -> Result<Action> {
|
||||
if let Some(key_event) = event.as_key_event() {
|
||||
// Handle events here that should not be passed on to the vim emulation handler.
|
||||
match self.handle_key_events(key_event)? {
|
||||
Action::Handled => return Ok(Action::Handled),
|
||||
Action::OpenTab => return Ok(Action::OpenTab),
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
if let Some(mouse_event) = event.as_mouse_event()
|
||||
&& let Action::Handled = self.handle_mouse_events(mouse_event)?
|
||||
{
|
||||
return Ok(Action::Handled);
|
||||
}
|
||||
Ok(Action::Pass)
|
||||
}
|
||||
|
||||
fn handle_key_events(&mut self, key: KeyEvent) -> Result<Action> {
|
||||
if key.code == KeyCode::Enter
|
||||
&& let Ok(selected) = self.selected()
|
||||
&& Path::new(&selected).is_file()
|
||||
{
|
||||
// Open a tab if the selected item is a file.
|
||||
return Ok(Action::OpenTab);
|
||||
}
|
||||
|
||||
let changed = match key.code {
|
||||
KeyCode::Up | KeyCode::Char('k') => self.tree_state.key_up(),
|
||||
KeyCode::Down | KeyCode::Char('j') => self.tree_state.key_down(),
|
||||
KeyCode::Left | KeyCode::Char('h') => {
|
||||
// Do not call key_left(); Calling it on a closed folder clears the selection.
|
||||
let key = self.tree_state.selected().to_owned();
|
||||
self.tree_state.close(key.as_ref())
|
||||
}
|
||||
KeyCode::Char(' ') | KeyCode::Enter => self
|
||||
.tree_state
|
||||
.toggle(self.tree_state.selected().to_owned()),
|
||||
KeyCode::Right | KeyCode::Char('l') => self.tree_state.key_right(),
|
||||
_ => false,
|
||||
};
|
||||
if changed {
|
||||
return Ok(Action::Handled);
|
||||
}
|
||||
Ok(Action::Noop)
|
||||
}
|
||||
|
||||
fn handle_mouse_events(&mut self, mouse: MouseEvent) -> Result<Action> {
|
||||
let changed = match mouse.kind {
|
||||
MouseEventKind::ScrollDown => self.tree_state.scroll_down(1),
|
||||
MouseEventKind::ScrollUp => self.tree_state.scroll_up(1),
|
||||
MouseEventKind::Down(_button) => self
|
||||
.tree_state
|
||||
.click_at(Position::new(mouse.column, mouse.row)),
|
||||
_ => false,
|
||||
};
|
||||
if changed {
|
||||
return Ok(Action::Handled);
|
||||
}
|
||||
Ok(Action::Noop)
|
||||
}
|
||||
|
||||
fn is_active(&self) -> bool {
|
||||
self.component_state.focus == Focus::Active
|
||||
}
|
||||
}
|
||||
95
src/tui/logger.rs
Normal file
95
src/tui/logger.rs
Normal file
@@ -0,0 +1,95 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
use crate::tui::component::{Action, Component, ComponentState, Focus, FocusState};
|
||||
use libclide::log::Loggable;
|
||||
use libclide_macros::Loggable;
|
||||
use log::LevelFilter;
|
||||
use ratatui::buffer::Buffer;
|
||||
use ratatui::crossterm::event::{Event, KeyCode, KeyEvent};
|
||||
use ratatui::layout::Rect;
|
||||
use ratatui::style::{Color, Style};
|
||||
use ratatui::widgets::Widget;
|
||||
use tui_logger::{TuiLoggerLevelOutput, TuiLoggerSmartWidget, TuiWidgetEvent, TuiWidgetState};
|
||||
|
||||
/// Any log written as info!(target:self.id(), "message") will work with this logger.
|
||||
/// The logger is bound to info!, debug!, error!, trace! macros within Tui::new().
|
||||
#[derive(Loggable)]
|
||||
pub struct Logger {
|
||||
state: TuiWidgetState,
|
||||
pub(crate) component_state: ComponentState,
|
||||
}
|
||||
|
||||
impl Logger {
|
||||
pub fn new() -> Self {
|
||||
libclide::trace!("Building {}", <Self as Loggable>::ID);
|
||||
let state = TuiWidgetState::new();
|
||||
state.transition(TuiWidgetEvent::HideKey);
|
||||
Self {
|
||||
state: state
|
||||
.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"
|
||||
)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Widget for &Logger {
|
||||
fn render(self, area: Rect, buf: &mut Buffer)
|
||||
where
|
||||
Self: Sized,
|
||||
{
|
||||
TuiLoggerSmartWidget::default()
|
||||
.border_style(Style::default().fg(self.component_state.get_active_color()))
|
||||
.style_error(Style::default().fg(Color::Red))
|
||||
.style_debug(Style::default().fg(Color::Green))
|
||||
.style_warn(Style::default().fg(Color::Yellow))
|
||||
.style_trace(Style::default().fg(Color::Magenta))
|
||||
.style_info(Style::default().fg(Color::Cyan))
|
||||
.output_separator(':')
|
||||
.output_timestamp(Some("%H:%M:%S".to_string()))
|
||||
.output_level(Some(TuiLoggerLevelOutput::Abbreviated))
|
||||
.output_target(true)
|
||||
.output_file(true)
|
||||
.output_line(true)
|
||||
.state(&self.state)
|
||||
.render(area, buf);
|
||||
}
|
||||
}
|
||||
|
||||
impl Component for Logger {
|
||||
fn handle_event(&mut self, event: Event) -> anyhow::Result<Action> {
|
||||
if let Some(key_event) = event.as_key_event() {
|
||||
return self.handle_key_events(key_event);
|
||||
}
|
||||
Ok(Action::Noop)
|
||||
}
|
||||
|
||||
fn handle_key_events(&mut self, key: KeyEvent) -> anyhow::Result<Action> {
|
||||
match key.code {
|
||||
KeyCode::Char('v') => self.state.transition(TuiWidgetEvent::SpaceKey),
|
||||
KeyCode::Esc => self.state.transition(TuiWidgetEvent::EscapeKey),
|
||||
KeyCode::PageUp => self.state.transition(TuiWidgetEvent::PrevPageKey),
|
||||
KeyCode::PageDown => self.state.transition(TuiWidgetEvent::NextPageKey),
|
||||
KeyCode::Up | KeyCode::Char('k') => self.state.transition(TuiWidgetEvent::UpKey),
|
||||
KeyCode::Down | KeyCode::Char('j') => self.state.transition(TuiWidgetEvent::DownKey),
|
||||
KeyCode::Left | KeyCode::Char('h') => self.state.transition(TuiWidgetEvent::LeftKey),
|
||||
KeyCode::Right | KeyCode::Char('l') => self.state.transition(TuiWidgetEvent::RightKey),
|
||||
KeyCode::Char('+') => self.state.transition(TuiWidgetEvent::PlusKey),
|
||||
KeyCode::Char('-') => self.state.transition(TuiWidgetEvent::MinusKey),
|
||||
KeyCode::Char(' ') => self.state.transition(TuiWidgetEvent::HideKey),
|
||||
KeyCode::Char('f') => self.state.transition(TuiWidgetEvent::FocusKey),
|
||||
_ => (),
|
||||
}
|
||||
Ok(Action::Pass)
|
||||
}
|
||||
|
||||
fn is_active(&self) -> bool {
|
||||
self.component_state.focus == Focus::Active
|
||||
}
|
||||
}
|
||||
245
src/tui/menu_bar.rs
Normal file
245
src/tui/menu_bar.rs
Normal file
@@ -0,0 +1,245 @@
|
||||
// SPDX-FileCopyrightText: 2026, Shaun Reed <shaunrd0@gmail.com>
|
||||
//
|
||||
// SPDX-License-Identifier: GNU General Public License v3.0 or later
|
||||
|
||||
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 libclide_macros::Loggable;
|
||||
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],
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Loggable)]
|
||||
pub struct MenuBar {
|
||||
selected: MenuBarItem,
|
||||
opened: Option<MenuBarItem>,
|
||||
pub(crate) component_state: ComponentState,
|
||||
list_state: ListState,
|
||||
}
|
||||
|
||||
impl MenuBar {
|
||||
const DEFAULT_HELP: &str = "(←/h)/(→/l): Select option | Enter: Choose selection";
|
||||
pub fn new() -> Self {
|
||||
libclide::trace!("Building");
|
||||
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.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 {
|
||||
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!("Building Rect under MenuBar popup {}", 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