Initial Commit
This commit is contained in:
Andy Dixon
@@ -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>.
|
||||
@@ -0,0 +1,76 @@
|
||||
# GGUF Editor
|
||||
|
||||
GGUF Editor is a terminal user interface for inspecting and editing the metadata
|
||||
stored in GGUF model files. It reads the GGUF header, metadata records and tensor
|
||||
directory, then lets you change scalar metadata values without loading the model
|
||||
tensors into memory.
|
||||
|
||||
The tool is intended for small, deliberate metadata changes on existing GGUF
|
||||
files. When you save, it writes a new file named `modified_<original-name>` next
|
||||
to the source file and streams the original tensor data into the output file.
|
||||
|
||||
## What it does
|
||||
|
||||
- Opens GGUF v2 and v3 files.
|
||||
- Shows metadata keys, value types and display values in a keyboard-driven table.
|
||||
- Shows the GGUF version, tensor count and source file size.
|
||||
- Edits scalar metadata values such as strings, booleans, integers and floats.
|
||||
- Adds new scalar metadata keys.
|
||||
- Deletes metadata keys.
|
||||
- Preserves tensor data by copying it from the original file instead of reading
|
||||
it all into memory.
|
||||
|
||||
Array metadata values are displayed but cannot currently be edited directly.
|
||||
|
||||
## Installation
|
||||
|
||||
You need Go installed.
|
||||
|
||||
```sh
|
||||
go install github.com/andydixon/gguf-editor@latest
|
||||
```
|
||||
|
||||
For local development from this repository:
|
||||
|
||||
```sh
|
||||
go build .
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
gguf-editor path/to/model.gguf
|
||||
```
|
||||
|
||||
If you built it locally:
|
||||
|
||||
```sh
|
||||
./gguf-editor path/to/model.gguf
|
||||
```
|
||||
|
||||
Inside the interface:
|
||||
|
||||
- `e` or `Enter` edits the selected scalar value.
|
||||
- `a` adds a new scalar metadata key.
|
||||
- `d` deletes the selected key.
|
||||
- `s` saves to `modified_<original-name>`.
|
||||
- `q` quits.
|
||||
- `Esc` cancels the current edit, add or confirmation dialogue.
|
||||
|
||||
Saving never overwrites the input file. For example, opening `model.gguf` and
|
||||
pressing `s` writes `modified_model.gguf` in the same directory.
|
||||
|
||||
## Implementation notes
|
||||
|
||||
The GGUF parser in `gguf.go` reads the magic value, version, tensor count,
|
||||
metadata count, metadata key-value pairs and tensor descriptors using
|
||||
little-endian binary reads. Tensor payload data is left on disk until save time.
|
||||
|
||||
The terminal interface in `main.go` is built with Charmbracelet Bubble Tea,
|
||||
Bubbles and Lip Gloss. It keeps a dirty flag for unsaved changes and rebuilds the
|
||||
metadata table after edits, additions and deletions.
|
||||
|
||||
## Licence
|
||||
|
||||
This project is licensed under the GNU General Public License version 3. See
|
||||
`LICENSE` for the full licence text.
|
||||
@@ -0,0 +1,568 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/binary"
|
||||
"fmt"
|
||||
"io"
|
||||
"math"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const (
|
||||
GGUFMagic uint32 = 0x46554747
|
||||
DefaultAlignment uint64 = 32
|
||||
)
|
||||
|
||||
type ValueType uint32
|
||||
|
||||
const (
|
||||
TypeUint8 ValueType = 0
|
||||
TypeInt8 ValueType = 1
|
||||
TypeUint16 ValueType = 2
|
||||
TypeInt16 ValueType = 3
|
||||
TypeUint32 ValueType = 4
|
||||
TypeInt32 ValueType = 5
|
||||
TypeFloat32 ValueType = 6
|
||||
TypeBool ValueType = 7
|
||||
TypeString ValueType = 8
|
||||
TypeArray ValueType = 9
|
||||
TypeUint64 ValueType = 10
|
||||
TypeInt64 ValueType = 11
|
||||
TypeFloat64 ValueType = 12
|
||||
)
|
||||
|
||||
var typeNames = map[ValueType]string{
|
||||
TypeUint8: "uint8", TypeInt8: "int8",
|
||||
TypeUint16: "uint16", TypeInt16: "int16",
|
||||
TypeUint32: "uint32", TypeInt32: "int32",
|
||||
TypeFloat32: "float32", TypeBool: "bool",
|
||||
TypeString: "string", TypeArray: "array",
|
||||
TypeUint64: "uint64", TypeInt64: "int64",
|
||||
TypeFloat64: "float64",
|
||||
}
|
||||
|
||||
// ScalarTypes returns all non-array value types for the type picker.
|
||||
var ScalarTypes = []ValueType{
|
||||
TypeString, TypeBool,
|
||||
TypeUint8, TypeInt8, TypeUint16, TypeInt16,
|
||||
TypeUint32, TypeInt32, TypeUint64, TypeInt64,
|
||||
TypeFloat32, TypeFloat64,
|
||||
}
|
||||
|
||||
func (t ValueType) String() string {
|
||||
if s, ok := typeNames[t]; ok {
|
||||
return s
|
||||
}
|
||||
return fmt.Sprintf("unknown(%d)", t)
|
||||
}
|
||||
|
||||
// MetaValue holds a single GGUF metadata value.
|
||||
type MetaValue struct {
|
||||
Type ValueType
|
||||
Data interface{}
|
||||
ElemType ValueType // only for arrays
|
||||
}
|
||||
|
||||
// DisplayString returns a human-readable representation of the value.
|
||||
func (v MetaValue) DisplayString() string {
|
||||
switch v.Type {
|
||||
case TypeBool:
|
||||
if v.Data.(bool) {
|
||||
return "true"
|
||||
}
|
||||
return "false"
|
||||
case TypeString:
|
||||
return v.Data.(string)
|
||||
case TypeFloat32:
|
||||
return strconv.FormatFloat(float64(v.Data.(float32)), 'g', -1, 32)
|
||||
case TypeFloat64:
|
||||
return strconv.FormatFloat(v.Data.(float64), 'g', -1, 64)
|
||||
case TypeArray:
|
||||
arr := v.Data.([]MetaValue)
|
||||
return fmt.Sprintf("[%s x %d]", v.ElemType, len(arr))
|
||||
default:
|
||||
return fmt.Sprintf("%v", v.Data)
|
||||
}
|
||||
}
|
||||
|
||||
// TypeName returns the display name for this value's type.
|
||||
func (v MetaValue) TypeName() string {
|
||||
if v.Type == TypeArray {
|
||||
return fmt.Sprintf("array[%s]", v.ElemType)
|
||||
}
|
||||
return v.Type.String()
|
||||
}
|
||||
|
||||
// KVPair is a metadata key-value pair.
|
||||
type KVPair struct {
|
||||
Key string
|
||||
Value MetaValue
|
||||
}
|
||||
|
||||
// TensorInfo describes a single tensor in the file.
|
||||
type TensorInfo struct {
|
||||
Name string
|
||||
NDims uint32
|
||||
Dims []uint64
|
||||
DType uint32
|
||||
Offset uint64
|
||||
}
|
||||
|
||||
// GGUFFile represents a parsed GGUF file's header and metadata.
|
||||
// Tensor data is never loaded into memory.
|
||||
type GGUFFile struct {
|
||||
Version uint32
|
||||
TensorCount uint64
|
||||
Metadata []KVPair
|
||||
Tensors []TensorInfo
|
||||
Alignment uint64
|
||||
|
||||
sourcePath string
|
||||
tensorDataStart int64
|
||||
fileSize int64
|
||||
}
|
||||
|
||||
// ParseGGUF reads only the header, metadata, and tensor info from a GGUF file.
|
||||
// No tensor data is loaded into memory.
|
||||
func ParseGGUF(path string) (*GGUFFile, error) {
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
info, err := f.Stat()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
g := &GGUFFile{
|
||||
sourcePath: path,
|
||||
fileSize: info.Size(),
|
||||
Alignment: DefaultAlignment,
|
||||
}
|
||||
|
||||
var magic uint32
|
||||
if err := binary.Read(f, binary.LittleEndian, &magic); err != nil {
|
||||
return nil, fmt.Errorf("reading magic: %w", err)
|
||||
}
|
||||
if magic != GGUFMagic {
|
||||
return nil, fmt.Errorf("not a GGUF file (magic: 0x%08X, expected 0x%08X)", magic, GGUFMagic)
|
||||
}
|
||||
|
||||
if err := binary.Read(f, binary.LittleEndian, &g.Version); err != nil {
|
||||
return nil, fmt.Errorf("reading version: %w", err)
|
||||
}
|
||||
if g.Version < 2 || g.Version > 3 {
|
||||
return nil, fmt.Errorf("unsupported GGUF version %d (supported: 2, 3)", g.Version)
|
||||
}
|
||||
|
||||
if err := binary.Read(f, binary.LittleEndian, &g.TensorCount); err != nil {
|
||||
return nil, fmt.Errorf("reading tensor count: %w", err)
|
||||
}
|
||||
var metaCount uint64
|
||||
if err := binary.Read(f, binary.LittleEndian, &metaCount); err != nil {
|
||||
return nil, fmt.Errorf("reading metadata count: %w", err)
|
||||
}
|
||||
|
||||
// Read metadata KV pairs
|
||||
g.Metadata = make([]KVPair, 0, metaCount)
|
||||
for i := uint64(0); i < metaCount; i++ {
|
||||
key, err := readString(f)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("metadata[%d] key: %w", i, err)
|
||||
}
|
||||
var vtype uint32
|
||||
if err := binary.Read(f, binary.LittleEndian, &vtype); err != nil {
|
||||
return nil, fmt.Errorf("metadata[%d] type: %w", i, err)
|
||||
}
|
||||
val, err := readValue(f, ValueType(vtype))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("metadata[%d] (%s) value: %w", i, key, err)
|
||||
}
|
||||
g.Metadata = append(g.Metadata, KVPair{Key: key, Value: val})
|
||||
|
||||
if key == "general.alignment" {
|
||||
switch val.Type {
|
||||
case TypeUint32:
|
||||
g.Alignment = uint64(val.Data.(uint32))
|
||||
case TypeUint64:
|
||||
g.Alignment = val.Data.(uint64)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Read tensor infos
|
||||
g.Tensors = make([]TensorInfo, 0, g.TensorCount)
|
||||
for i := uint64(0); i < g.TensorCount; i++ {
|
||||
name, err := readString(f)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("tensor[%d] name: %w", i, err)
|
||||
}
|
||||
var ndims uint32
|
||||
if err := binary.Read(f, binary.LittleEndian, &ndims); err != nil {
|
||||
return nil, fmt.Errorf("tensor[%d] ndims: %w", i, err)
|
||||
}
|
||||
dims := make([]uint64, ndims)
|
||||
for d := uint32(0); d < ndims; d++ {
|
||||
if err := binary.Read(f, binary.LittleEndian, &dims[d]); err != nil {
|
||||
return nil, fmt.Errorf("tensor[%d] dim[%d]: %w", i, d, err)
|
||||
}
|
||||
}
|
||||
var dtype uint32
|
||||
if err := binary.Read(f, binary.LittleEndian, &dtype); err != nil {
|
||||
return nil, fmt.Errorf("tensor[%d] dtype: %w", i, err)
|
||||
}
|
||||
var offset uint64
|
||||
if err := binary.Read(f, binary.LittleEndian, &offset); err != nil {
|
||||
return nil, fmt.Errorf("tensor[%d] offset: %w", i, err)
|
||||
}
|
||||
g.Tensors = append(g.Tensors, TensorInfo{
|
||||
Name: name, NDims: ndims, Dims: dims, DType: dtype, Offset: offset,
|
||||
})
|
||||
}
|
||||
|
||||
// Record where tensor data begins (aligned)
|
||||
pos, err := f.Seek(0, io.SeekCurrent)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("getting position: %w", err)
|
||||
}
|
||||
g.tensorDataStart = alignUp(pos, int64(g.Alignment))
|
||||
|
||||
return g, nil
|
||||
}
|
||||
|
||||
// Save writes the GGUF file with (potentially modified) metadata to outPath.
|
||||
// Tensor data is streamed from the original file — never fully loaded.
|
||||
func (g *GGUFFile) Save(outPath string) error {
|
||||
out, err := os.Create(outPath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer out.Close()
|
||||
|
||||
cw := &countingWriter{w: out}
|
||||
|
||||
// Header
|
||||
if err := binary.Write(cw, binary.LittleEndian, GGUFMagic); err != nil {
|
||||
return fmt.Errorf("writing magic: %w", err)
|
||||
}
|
||||
if err := binary.Write(cw, binary.LittleEndian, g.Version); err != nil {
|
||||
return fmt.Errorf("writing version: %w", err)
|
||||
}
|
||||
if err := binary.Write(cw, binary.LittleEndian, g.TensorCount); err != nil {
|
||||
return fmt.Errorf("writing tensor count: %w", err)
|
||||
}
|
||||
if err := binary.Write(cw, binary.LittleEndian, uint64(len(g.Metadata))); err != nil {
|
||||
return fmt.Errorf("writing metadata count: %w", err)
|
||||
}
|
||||
|
||||
// Metadata KV pairs
|
||||
for _, kv := range g.Metadata {
|
||||
if err := writeString(cw, kv.Key); err != nil {
|
||||
return fmt.Errorf("writing key %q: %w", kv.Key, err)
|
||||
}
|
||||
if err := binary.Write(cw, binary.LittleEndian, uint32(kv.Value.Type)); err != nil {
|
||||
return fmt.Errorf("writing type for %q: %w", kv.Key, err)
|
||||
}
|
||||
if err := writeValue(cw, kv.Value); err != nil {
|
||||
return fmt.Errorf("writing value for %q: %w", kv.Key, err)
|
||||
}
|
||||
}
|
||||
|
||||
// Tensor infos
|
||||
for _, t := range g.Tensors {
|
||||
if err := writeString(cw, t.Name); err != nil {
|
||||
return fmt.Errorf("writing tensor name: %w", err)
|
||||
}
|
||||
if err := binary.Write(cw, binary.LittleEndian, t.NDims); err != nil {
|
||||
return err
|
||||
}
|
||||
for _, d := range t.Dims {
|
||||
if err := binary.Write(cw, binary.LittleEndian, d); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
if err := binary.Write(cw, binary.LittleEndian, t.DType); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := binary.Write(cw, binary.LittleEndian, t.Offset); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// Alignment padding
|
||||
aligned := alignUp(cw.count, int64(g.Alignment))
|
||||
padLen := aligned - cw.count
|
||||
if padLen > 0 {
|
||||
if _, err := out.Write(make([]byte, padLen)); err != nil {
|
||||
return fmt.Errorf("writing padding: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Stream-copy tensor data from original file
|
||||
src, err := os.Open(g.sourcePath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("opening source for tensor data: %w", err)
|
||||
}
|
||||
defer src.Close()
|
||||
|
||||
if _, err := src.Seek(g.tensorDataStart, io.SeekStart); err != nil {
|
||||
return fmt.Errorf("seeking to tensor data: %w", err)
|
||||
}
|
||||
|
||||
tensorLen := g.fileSize - g.tensorDataStart
|
||||
if tensorLen > 0 {
|
||||
if _, err := io.CopyN(out, src, tensorLen); err != nil {
|
||||
return fmt.Errorf("copying tensor data: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// ParseValueFromString parses a user-entered string into a MetaValue of the given type.
|
||||
func ParseValueFromString(s string, t ValueType) (MetaValue, error) {
|
||||
s = strings.TrimSpace(s)
|
||||
switch t {
|
||||
case TypeUint8:
|
||||
v, err := strconv.ParseUint(s, 10, 8)
|
||||
return MetaValue{Type: t, Data: uint8(v)}, err
|
||||
case TypeInt8:
|
||||
v, err := strconv.ParseInt(s, 10, 8)
|
||||
return MetaValue{Type: t, Data: int8(v)}, err
|
||||
case TypeUint16:
|
||||
v, err := strconv.ParseUint(s, 10, 16)
|
||||
return MetaValue{Type: t, Data: uint16(v)}, err
|
||||
case TypeInt16:
|
||||
v, err := strconv.ParseInt(s, 10, 16)
|
||||
return MetaValue{Type: t, Data: int16(v)}, err
|
||||
case TypeUint32:
|
||||
v, err := strconv.ParseUint(s, 10, 32)
|
||||
return MetaValue{Type: t, Data: uint32(v)}, err
|
||||
case TypeInt32:
|
||||
v, err := strconv.ParseInt(s, 10, 32)
|
||||
return MetaValue{Type: t, Data: int32(v)}, err
|
||||
case TypeUint64:
|
||||
v, err := strconv.ParseUint(s, 10, 64)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeInt64:
|
||||
v, err := strconv.ParseInt(s, 10, 64)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeFloat32:
|
||||
v, err := strconv.ParseFloat(s, 32)
|
||||
return MetaValue{Type: t, Data: float32(v)}, err
|
||||
case TypeFloat64:
|
||||
v, err := strconv.ParseFloat(s, 64)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeBool:
|
||||
v, err := strconv.ParseBool(s)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeString:
|
||||
return MetaValue{Type: t, Data: s}, nil
|
||||
default:
|
||||
return MetaValue{}, fmt.Errorf("cannot parse type %s from string", t)
|
||||
}
|
||||
}
|
||||
|
||||
// --- internal helpers ---
|
||||
|
||||
func readString(r io.Reader) (string, error) {
|
||||
var length uint64
|
||||
if err := binary.Read(r, binary.LittleEndian, &length); err != nil {
|
||||
return "", err
|
||||
}
|
||||
if length > 1<<30 { // sanity limit: 1 GB
|
||||
return "", fmt.Errorf("string length %d exceeds sanity limit", length)
|
||||
}
|
||||
buf := make([]byte, length)
|
||||
if _, err := io.ReadFull(r, buf); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return string(buf), nil
|
||||
}
|
||||
|
||||
func readValue(r io.Reader, t ValueType) (MetaValue, error) {
|
||||
switch t {
|
||||
case TypeUint8:
|
||||
var v uint8
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeInt8:
|
||||
var v int8
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeUint16:
|
||||
var v uint16
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeInt16:
|
||||
var v int16
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeUint32:
|
||||
var v uint32
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeInt32:
|
||||
var v int32
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeFloat32:
|
||||
var v float32
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeBool:
|
||||
var v uint8
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v != 0}, err
|
||||
case TypeString:
|
||||
s, err := readString(r)
|
||||
return MetaValue{Type: t, Data: s}, err
|
||||
case TypeUint64:
|
||||
var v uint64
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeInt64:
|
||||
var v int64
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeFloat64:
|
||||
var v float64
|
||||
err := binary.Read(r, binary.LittleEndian, &v)
|
||||
return MetaValue{Type: t, Data: v}, err
|
||||
case TypeArray:
|
||||
var elemType uint32
|
||||
if err := binary.Read(r, binary.LittleEndian, &elemType); err != nil {
|
||||
return MetaValue{}, fmt.Errorf("array elem type: %w", err)
|
||||
}
|
||||
var count uint64
|
||||
if err := binary.Read(r, binary.LittleEndian, &count); err != nil {
|
||||
return MetaValue{}, fmt.Errorf("array count: %w", err)
|
||||
}
|
||||
if count > 1<<30 {
|
||||
return MetaValue{}, fmt.Errorf("array count %d exceeds sanity limit", count)
|
||||
}
|
||||
arr := make([]MetaValue, count)
|
||||
for i := uint64(0); i < count; i++ {
|
||||
v, err := readValue(r, ValueType(elemType))
|
||||
if err != nil {
|
||||
return MetaValue{}, fmt.Errorf("array[%d]: %w", i, err)
|
||||
}
|
||||
arr[i] = v
|
||||
}
|
||||
return MetaValue{Type: TypeArray, Data: arr, ElemType: ValueType(elemType)}, nil
|
||||
default:
|
||||
return MetaValue{}, fmt.Errorf("unknown value type: %d", t)
|
||||
}
|
||||
}
|
||||
|
||||
func writeString(w io.Writer, s string) error {
|
||||
if err := binary.Write(w, binary.LittleEndian, uint64(len(s))); err != nil {
|
||||
return err
|
||||
}
|
||||
_, err := w.Write([]byte(s))
|
||||
return err
|
||||
}
|
||||
|
||||
func writeValue(w io.Writer, v MetaValue) error {
|
||||
switch v.Type {
|
||||
case TypeUint8:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(uint8))
|
||||
case TypeInt8:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(int8))
|
||||
case TypeUint16:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(uint16))
|
||||
case TypeInt16:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(int16))
|
||||
case TypeUint32:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(uint32))
|
||||
case TypeInt32:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(int32))
|
||||
case TypeFloat32:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(float32))
|
||||
case TypeBool:
|
||||
b := uint8(0)
|
||||
if v.Data.(bool) {
|
||||
b = 1
|
||||
}
|
||||
return binary.Write(w, binary.LittleEndian, b)
|
||||
case TypeString:
|
||||
return writeString(w, v.Data.(string))
|
||||
case TypeUint64:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(uint64))
|
||||
case TypeInt64:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(int64))
|
||||
case TypeFloat64:
|
||||
return binary.Write(w, binary.LittleEndian, v.Data.(float64))
|
||||
case TypeArray:
|
||||
arr := v.Data.([]MetaValue)
|
||||
if err := binary.Write(w, binary.LittleEndian, uint32(v.ElemType)); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := binary.Write(w, binary.LittleEndian, uint64(len(arr))); err != nil {
|
||||
return err
|
||||
}
|
||||
for i, elem := range arr {
|
||||
if err := writeValue(w, elem); err != nil {
|
||||
return fmt.Errorf("array[%d]: %w", i, err)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("unknown type: %d", v.Type)
|
||||
}
|
||||
}
|
||||
|
||||
func alignUp(pos, align int64) int64 {
|
||||
return (pos + align - 1) & ^(align - 1)
|
||||
}
|
||||
|
||||
type countingWriter struct {
|
||||
w io.Writer
|
||||
count int64
|
||||
}
|
||||
|
||||
func (cw *countingWriter) Write(p []byte) (int, error) {
|
||||
n, err := cw.w.Write(p)
|
||||
cw.count += int64(n)
|
||||
return n, err
|
||||
}
|
||||
|
||||
// humanSize formats a byte count as a human-readable string.
|
||||
func humanSize(b int64) string {
|
||||
const unit = 1024
|
||||
if b < unit {
|
||||
return fmt.Sprintf("%d B", b)
|
||||
}
|
||||
div, exp := int64(unit), 0
|
||||
for n := b / unit; n >= unit; n /= unit {
|
||||
div *= unit
|
||||
exp++
|
||||
}
|
||||
return fmt.Sprintf("%.1f %ciB", float64(b)/float64(div), "KMGTPE"[exp])
|
||||
}
|
||||
|
||||
// ggufTypeName returns the GGUF tensor type name.
|
||||
func ggufTypeName(t uint32) string {
|
||||
names := map[uint32]string{
|
||||
0: "F32", 1: "F16", 2: "Q4_0", 3: "Q4_1",
|
||||
6: "Q5_0", 7: "Q5_1", 8: "Q8_0", 9: "Q8_1",
|
||||
10: "Q2_K", 11: "Q3_K", 12: "Q4_K", 13: "Q5_K", 14: "Q6_K", 15: "Q8_K",
|
||||
16: "IQ2_XXS", 17: "IQ2_XS", 18: "IQ3_XXS", 19: "IQ1_S", 20: "IQ4_NL",
|
||||
21: "IQ3_S", 22: "IQ2_S", 23: "IQ4_XS",
|
||||
24: "I8", 25: "I16", 26: "I32", 27: "I64",
|
||||
28: "F64", 29: "IQ1_M",
|
||||
}
|
||||
if s, ok := names[t]; ok {
|
||||
return s
|
||||
}
|
||||
return fmt.Sprintf("type_%d", t)
|
||||
}
|
||||
|
||||
// NaN/Inf-safe float display
|
||||
func init() {
|
||||
_ = math.NaN()
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
module github.com/andydixon/gguf-editor
|
||||
|
||||
go 1.26.1
|
||||
|
||||
require (
|
||||
github.com/charmbracelet/bubbles v1.0.0
|
||||
github.com/charmbracelet/bubbletea v1.3.10
|
||||
github.com/charmbracelet/lipgloss v1.1.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/atotto/clipboard v0.1.4 // indirect
|
||||
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
|
||||
github.com/charmbracelet/colorprofile v0.4.1 // indirect
|
||||
github.com/charmbracelet/x/ansi v0.11.6 // indirect
|
||||
github.com/charmbracelet/x/cellbuf v0.0.15 // indirect
|
||||
github.com/charmbracelet/x/term v0.2.2 // indirect
|
||||
github.com/clipperhouse/displaywidth v0.9.0 // indirect
|
||||
github.com/clipperhouse/stringish v0.1.1 // indirect
|
||||
github.com/clipperhouse/uax29/v2 v2.5.0 // indirect
|
||||
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
|
||||
github.com/lucasb-eyer/go-colorful v1.3.0 // indirect
|
||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||
github.com/mattn/go-localereader v0.0.1 // indirect
|
||||
github.com/mattn/go-runewidth v0.0.19 // indirect
|
||||
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect
|
||||
github.com/muesli/cancelreader v0.2.2 // indirect
|
||||
github.com/muesli/termenv v0.16.0 // indirect
|
||||
github.com/rivo/uniseg v0.4.7 // indirect
|
||||
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
|
||||
golang.org/x/sys v0.38.0 // indirect
|
||||
golang.org/x/text v0.3.8 // indirect
|
||||
)
|
||||
@@ -0,0 +1,56 @@
|
||||
github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
|
||||
github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
|
||||
github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
|
||||
github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
|
||||
github.com/aymanbagabas/go-udiff v0.3.1 h1:LV+qyBQ2pqe0u42ZsUEtPiCaUoqgA9gYRDs3vj1nolY=
|
||||
github.com/aymanbagabas/go-udiff v0.3.1/go.mod h1:G0fsKmG+P6ylD0r6N/KgQD/nWzgfnl8ZBcNLgcbrw8E=
|
||||
github.com/charmbracelet/bubbles v1.0.0 h1:12J8/ak/uCZEMQ6KU7pcfwceyjLlWsDLAxB5fXonfvc=
|
||||
github.com/charmbracelet/bubbles v1.0.0/go.mod h1:9d/Zd5GdnauMI5ivUIVisuEm3ave1XwXtD1ckyV6r3E=
|
||||
github.com/charmbracelet/bubbletea v1.3.10 h1:otUDHWMMzQSB0Pkc87rm691KZ3SWa4KUlvF9nRvCICw=
|
||||
github.com/charmbracelet/bubbletea v1.3.10/go.mod h1:ORQfo0fk8U+po9VaNvnV95UPWA1BitP1E0N6xJPlHr4=
|
||||
github.com/charmbracelet/colorprofile v0.4.1 h1:a1lO03qTrSIRaK8c3JRxJDZOvhvIeSco3ej+ngLk1kk=
|
||||
github.com/charmbracelet/colorprofile v0.4.1/go.mod h1:U1d9Dljmdf9DLegaJ0nGZNJvoXAhayhmidOdcBwAvKk=
|
||||
github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
|
||||
github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
|
||||
github.com/charmbracelet/x/ansi v0.11.6 h1:GhV21SiDz/45W9AnV2R61xZMRri5NlLnl6CVF7ihZW8=
|
||||
github.com/charmbracelet/x/ansi v0.11.6/go.mod h1:2JNYLgQUsyqaiLovhU2Rv/pb8r6ydXKS3NIttu3VGZQ=
|
||||
github.com/charmbracelet/x/cellbuf v0.0.15 h1:ur3pZy0o6z/R7EylET877CBxaiE1Sp1GMxoFPAIztPI=
|
||||
github.com/charmbracelet/x/cellbuf v0.0.15/go.mod h1:J1YVbR7MUuEGIFPCaaZ96KDl5NoS0DAWkskup+mOY+Q=
|
||||
github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91 h1:payRxjMjKgx2PaCWLZ4p3ro9y97+TVLZNaRZgJwSVDQ=
|
||||
github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U=
|
||||
github.com/charmbracelet/x/term v0.2.2 h1:xVRT/S2ZcKdhhOuSP4t5cLi5o+JxklsoEObBSgfgZRk=
|
||||
github.com/charmbracelet/x/term v0.2.2/go.mod h1:kF8CY5RddLWrsgVwpw4kAa6TESp6EB5y3uxGLeCqzAI=
|
||||
github.com/clipperhouse/displaywidth v0.9.0 h1:Qb4KOhYwRiN3viMv1v/3cTBlz3AcAZX3+y9OLhMtAtA=
|
||||
github.com/clipperhouse/displaywidth v0.9.0/go.mod h1:aCAAqTlh4GIVkhQnJpbL0T/WfcrJXHcj8C0yjYcjOZA=
|
||||
github.com/clipperhouse/stringish v0.1.1 h1:+NSqMOr3GR6k1FdRhhnXrLfztGzuG+VuFDfatpWHKCs=
|
||||
github.com/clipperhouse/stringish v0.1.1/go.mod h1:v/WhFtE1q0ovMta2+m+UbpZ+2/HEXNWYXQgCt4hdOzA=
|
||||
github.com/clipperhouse/uax29/v2 v2.5.0 h1:x7T0T4eTHDONxFJsL94uKNKPHrclyFI0lm7+w94cO8U=
|
||||
github.com/clipperhouse/uax29/v2 v2.5.0/go.mod h1:Wn1g7MK6OoeDT0vL+Q0SQLDz/KpfsVRgg6W7ihQeh4g=
|
||||
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4=
|
||||
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM=
|
||||
github.com/lucasb-eyer/go-colorful v1.3.0 h1:2/yBRLdWBZKrf7gB40FoiKfAWYQ0lqNcbuQwVHXptag=
|
||||
github.com/lucasb-eyer/go-colorful v1.3.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
|
||||
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
||||
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||
github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4=
|
||||
github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88=
|
||||
github.com/mattn/go-runewidth v0.0.19 h1:v++JhqYnZuu5jSKrk9RbgF5v4CGUjqRfBm05byFGLdw=
|
||||
github.com/mattn/go-runewidth v0.0.19/go.mod h1:XBkDxAl56ILZc9knddidhrOlY5R/pDhgLpndooCuJAs=
|
||||
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D264iyp3TiX5OmNcI5cIARiQI=
|
||||
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo=
|
||||
github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA=
|
||||
github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo=
|
||||
github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
|
||||
github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
|
||||
github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
|
||||
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
|
||||
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
|
||||
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
|
||||
golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI=
|
||||
golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo=
|
||||
golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc=
|
||||
golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/text v0.3.8 h1:nAL+RVCQ9uMn3vJZbV+MRnydTJFPf8qqY42YiA6MrqY=
|
||||
golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
|
||||
@@ -0,0 +1,633 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/charmbracelet/bubbles/table"
|
||||
"github.com/charmbracelet/bubbles/textinput"
|
||||
tea "github.com/charmbracelet/bubbletea"
|
||||
"github.com/charmbracelet/lipgloss"
|
||||
)
|
||||
|
||||
// ── Styles ──────────────────────────────────────────────────────────
|
||||
|
||||
var (
|
||||
titleStyle = lipgloss.NewStyle().
|
||||
Bold(true).
|
||||
Foreground(lipgloss.Color("#FAFAFA")).
|
||||
Background(lipgloss.Color("#7C3AED")).
|
||||
Padding(0, 2)
|
||||
|
||||
infoStyle = lipgloss.NewStyle().
|
||||
Foreground(lipgloss.Color("#A78BFA")).
|
||||
Bold(true)
|
||||
|
||||
statusOkStyle = lipgloss.NewStyle().
|
||||
Foreground(lipgloss.Color("#10B981"))
|
||||
|
||||
statusErrStyle = lipgloss.NewStyle().
|
||||
Foreground(lipgloss.Color("#EF4444"))
|
||||
|
||||
helpStyle = lipgloss.NewStyle().
|
||||
Foreground(lipgloss.Color("#6B7280"))
|
||||
|
||||
overlayStyle = lipgloss.NewStyle().
|
||||
Border(lipgloss.RoundedBorder()).
|
||||
BorderForeground(lipgloss.Color("#7C3AED")).
|
||||
Padding(1, 2).
|
||||
Width(60)
|
||||
|
||||
overlayTitleStyle = lipgloss.NewStyle().
|
||||
Bold(true).
|
||||
Foreground(lipgloss.Color("#C4B5FD")).
|
||||
MarginBottom(1)
|
||||
|
||||
dimStyle = lipgloss.NewStyle().
|
||||
Foreground(lipgloss.Color("#4B5563"))
|
||||
|
||||
typeActiveStyle = lipgloss.NewStyle().
|
||||
Bold(true).
|
||||
Foreground(lipgloss.Color("#FAFAFA")).
|
||||
Background(lipgloss.Color("#7C3AED")).
|
||||
Padding(0, 1)
|
||||
|
||||
typeInactiveStyle = lipgloss.NewStyle().
|
||||
Foreground(lipgloss.Color("#9CA3AF")).
|
||||
Padding(0, 1)
|
||||
|
||||
modifiedStyle = lipgloss.NewStyle().
|
||||
Foreground(lipgloss.Color("#F59E0B")).
|
||||
Bold(true)
|
||||
)
|
||||
|
||||
// ── App State ───────────────────────────────────────────────────────
|
||||
|
||||
type appState int
|
||||
|
||||
const (
|
||||
stateTable appState = iota
|
||||
stateEdit // editing a value
|
||||
stateAdd // adding new KV (multi-step)
|
||||
stateConfirm // confirm dialog (save/delete)
|
||||
)
|
||||
|
||||
type confirmAction int
|
||||
|
||||
const (
|
||||
confirmSave confirmAction = iota
|
||||
confirmDelete
|
||||
)
|
||||
|
||||
// ── Model ───────────────────────────────────────────────────────────
|
||||
|
||||
type model struct {
|
||||
state appState
|
||||
gguf *GGUFFile
|
||||
filePath string
|
||||
dirty bool
|
||||
|
||||
// table
|
||||
table table.Model
|
||||
width int
|
||||
height int
|
||||
|
||||
// edit
|
||||
editInput textinput.Model
|
||||
editIdx int
|
||||
|
||||
// add (step 0: key, step 1: type picker, step 2: value)
|
||||
addStep int
|
||||
addKey string
|
||||
addType int // index into ScalarTypes
|
||||
addInput textinput.Model
|
||||
|
||||
// confirm
|
||||
confirmMsg string
|
||||
confirmAction confirmAction
|
||||
|
||||
// status
|
||||
statusMsg string
|
||||
statusIsErr bool
|
||||
}
|
||||
|
||||
func initialModel(g *GGUFFile, path string) model {
|
||||
ti := textinput.New()
|
||||
ti.CharLimit = 4096
|
||||
|
||||
ai := textinput.New()
|
||||
ai.CharLimit = 4096
|
||||
|
||||
m := model{
|
||||
state: stateTable,
|
||||
gguf: g,
|
||||
filePath: path,
|
||||
editInput: ti,
|
||||
addInput: ai,
|
||||
statusMsg: fmt.Sprintf("Loaded %d metadata entries, %d tensors (%s)",
|
||||
len(g.Metadata), g.TensorCount, humanSize(g.fileSize)),
|
||||
}
|
||||
|
||||
m.table = m.buildTable(80, 30)
|
||||
return m
|
||||
}
|
||||
|
||||
func (m model) buildTable(width, height int) table.Model {
|
||||
keyW := max(20, (width-8)*45/100)
|
||||
typeW := 14
|
||||
valW := max(10, width-keyW-typeW-8)
|
||||
|
||||
cols := []table.Column{
|
||||
{Title: "#", Width: 4},
|
||||
{Title: "Key", Width: keyW},
|
||||
{Title: "Type", Width: typeW},
|
||||
{Title: "Value", Width: valW},
|
||||
}
|
||||
|
||||
rows := make([]table.Row, len(m.gguf.Metadata))
|
||||
for i, kv := range m.gguf.Metadata {
|
||||
val := kv.Value.DisplayString()
|
||||
if len(val) > valW-2 {
|
||||
val = val[:valW-5] + "..."
|
||||
}
|
||||
rows[i] = table.Row{
|
||||
fmt.Sprintf("%d", i),
|
||||
kv.Key,
|
||||
kv.Value.TypeName(),
|
||||
val,
|
||||
}
|
||||
}
|
||||
|
||||
tblHeight := height - 7
|
||||
if tblHeight < 5 {
|
||||
tblHeight = 5
|
||||
}
|
||||
|
||||
t := table.New(
|
||||
table.WithColumns(cols),
|
||||
table.WithRows(rows),
|
||||
table.WithFocused(true),
|
||||
table.WithHeight(tblHeight),
|
||||
)
|
||||
|
||||
s := table.DefaultStyles()
|
||||
s.Header = s.Header.
|
||||
BorderStyle(lipgloss.NormalBorder()).
|
||||
BorderForeground(lipgloss.Color("#7C3AED")).
|
||||
BorderBottom(true).
|
||||
Bold(true).
|
||||
Foreground(lipgloss.Color("#C4B5FD"))
|
||||
s.Selected = s.Selected.
|
||||
Foreground(lipgloss.Color("#FAFAFA")).
|
||||
Background(lipgloss.Color("#4C1D95")).
|
||||
Bold(false)
|
||||
t.SetStyles(s)
|
||||
|
||||
return t
|
||||
}
|
||||
|
||||
func (m model) Init() tea.Cmd {
|
||||
return nil
|
||||
}
|
||||
|
||||
// ── Update ──────────────────────────────────────────────────────────
|
||||
|
||||
func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case tea.WindowSizeMsg:
|
||||
m.width = msg.Width
|
||||
m.height = msg.Height
|
||||
cur := m.table.Cursor()
|
||||
m.table = m.buildTable(m.width, m.height)
|
||||
m.table.SetCursor(cur)
|
||||
return m, nil
|
||||
}
|
||||
|
||||
switch m.state {
|
||||
case stateTable:
|
||||
return m.updateTable(msg)
|
||||
case stateEdit:
|
||||
return m.updateEdit(msg)
|
||||
case stateAdd:
|
||||
return m.updateAdd(msg)
|
||||
case stateConfirm:
|
||||
return m.updateConfirm(msg)
|
||||
}
|
||||
return m, nil
|
||||
}
|
||||
|
||||
func (m model) updateTable(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case tea.KeyMsg:
|
||||
switch msg.String() {
|
||||
case "q", "ctrl+c":
|
||||
return m, tea.Quit
|
||||
case "e", "enter":
|
||||
if len(m.gguf.Metadata) == 0 {
|
||||
return m, nil
|
||||
}
|
||||
idx := m.table.Cursor()
|
||||
kv := m.gguf.Metadata[idx]
|
||||
if kv.Value.Type == TypeArray {
|
||||
m.statusMsg = "Array values cannot be edited directly"
|
||||
m.statusIsErr = true
|
||||
return m, nil
|
||||
}
|
||||
m.state = stateEdit
|
||||
m.editIdx = idx
|
||||
m.editInput.SetValue(kv.Value.DisplayString())
|
||||
m.editInput.Focus()
|
||||
m.editInput.CursorEnd()
|
||||
return m, textinput.Blink
|
||||
case "a":
|
||||
m.state = stateAdd
|
||||
m.addStep = 0
|
||||
m.addType = 0
|
||||
m.addKey = ""
|
||||
m.addInput.SetValue("")
|
||||
m.addInput.Placeholder = "metadata.key.name"
|
||||
m.addInput.Focus()
|
||||
return m, textinput.Blink
|
||||
case "d":
|
||||
if len(m.gguf.Metadata) == 0 {
|
||||
return m, nil
|
||||
}
|
||||
idx := m.table.Cursor()
|
||||
m.state = stateConfirm
|
||||
m.confirmAction = confirmDelete
|
||||
m.confirmMsg = fmt.Sprintf("Delete key %q?", m.gguf.Metadata[idx].Key)
|
||||
return m, nil
|
||||
case "s":
|
||||
outPath := m.outputPath()
|
||||
m.state = stateConfirm
|
||||
m.confirmAction = confirmSave
|
||||
m.confirmMsg = fmt.Sprintf("Save as %s?", filepath.Base(outPath))
|
||||
return m, nil
|
||||
}
|
||||
}
|
||||
|
||||
var cmd tea.Cmd
|
||||
m.table, cmd = m.table.Update(msg)
|
||||
return m, cmd
|
||||
}
|
||||
|
||||
func (m model) updateEdit(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case tea.KeyMsg:
|
||||
switch msg.String() {
|
||||
case "enter":
|
||||
val, err := ParseValueFromString(m.editInput.Value(), m.gguf.Metadata[m.editIdx].Value.Type)
|
||||
if err != nil {
|
||||
m.statusMsg = fmt.Sprintf("Invalid value: %v", err)
|
||||
m.statusIsErr = true
|
||||
return m, nil
|
||||
}
|
||||
m.gguf.Metadata[m.editIdx].Value = val
|
||||
m.dirty = true
|
||||
m.statusMsg = fmt.Sprintf("Updated %q", m.gguf.Metadata[m.editIdx].Key)
|
||||
m.statusIsErr = false
|
||||
m.state = stateTable
|
||||
m.rebuildRows()
|
||||
return m, nil
|
||||
case "esc":
|
||||
m.state = stateTable
|
||||
return m, nil
|
||||
}
|
||||
}
|
||||
|
||||
var cmd tea.Cmd
|
||||
m.editInput, cmd = m.editInput.Update(msg)
|
||||
return m, cmd
|
||||
}
|
||||
|
||||
func (m model) updateAdd(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case tea.KeyMsg:
|
||||
switch msg.String() {
|
||||
case "esc":
|
||||
m.state = stateTable
|
||||
return m, nil
|
||||
case "enter":
|
||||
switch m.addStep {
|
||||
case 0: // key entered
|
||||
key := strings.TrimSpace(m.addInput.Value())
|
||||
if key == "" {
|
||||
m.statusMsg = "Key cannot be empty"
|
||||
m.statusIsErr = true
|
||||
return m, nil
|
||||
}
|
||||
m.addKey = key
|
||||
m.addStep = 1
|
||||
return m, nil
|
||||
case 1: // type selected
|
||||
m.addStep = 2
|
||||
m.addInput.SetValue("")
|
||||
m.addInput.Placeholder = fmt.Sprintf("Enter %s value", ScalarTypes[m.addType])
|
||||
m.addInput.Focus()
|
||||
return m, textinput.Blink
|
||||
case 2: // value entered
|
||||
t := ScalarTypes[m.addType]
|
||||
val, err := ParseValueFromString(m.addInput.Value(), t)
|
||||
if err != nil {
|
||||
m.statusMsg = fmt.Sprintf("Invalid %s: %v", t, err)
|
||||
m.statusIsErr = true
|
||||
return m, nil
|
||||
}
|
||||
m.gguf.Metadata = append(m.gguf.Metadata, KVPair{Key: m.addKey, Value: val})
|
||||
m.dirty = true
|
||||
m.statusMsg = fmt.Sprintf("Added %q (%s)", m.addKey, t)
|
||||
m.statusIsErr = false
|
||||
m.state = stateTable
|
||||
m.rebuildRows()
|
||||
return m, nil
|
||||
}
|
||||
case "left", "shift+tab":
|
||||
if m.addStep == 1 {
|
||||
m.addType = (m.addType - 1 + len(ScalarTypes)) % len(ScalarTypes)
|
||||
return m, nil
|
||||
}
|
||||
case "right", "tab":
|
||||
if m.addStep == 1 {
|
||||
m.addType = (m.addType + 1) % len(ScalarTypes)
|
||||
return m, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if m.addStep != 1 {
|
||||
var cmd tea.Cmd
|
||||
m.addInput, cmd = m.addInput.Update(msg)
|
||||
return m, cmd
|
||||
}
|
||||
return m, nil
|
||||
}
|
||||
|
||||
func (m model) updateConfirm(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case tea.KeyMsg:
|
||||
switch msg.String() {
|
||||
case "y", "enter":
|
||||
switch m.confirmAction {
|
||||
case confirmSave:
|
||||
outPath := m.outputPath()
|
||||
if err := m.gguf.Save(outPath); err != nil {
|
||||
m.statusMsg = fmt.Sprintf("Save failed: %v", err)
|
||||
m.statusIsErr = true
|
||||
} else {
|
||||
m.statusMsg = fmt.Sprintf("Saved to %s", filepath.Base(outPath))
|
||||
m.statusIsErr = false
|
||||
m.dirty = false
|
||||
}
|
||||
case confirmDelete:
|
||||
idx := m.table.Cursor()
|
||||
key := m.gguf.Metadata[idx].Key
|
||||
m.gguf.Metadata = append(m.gguf.Metadata[:idx], m.gguf.Metadata[idx+1:]...)
|
||||
m.dirty = true
|
||||
m.statusMsg = fmt.Sprintf("Deleted %q", key)
|
||||
m.statusIsErr = false
|
||||
m.rebuildRows()
|
||||
if idx >= len(m.gguf.Metadata) && idx > 0 {
|
||||
m.table.SetCursor(idx - 1)
|
||||
}
|
||||
}
|
||||
m.state = stateTable
|
||||
return m, nil
|
||||
case "n", "esc":
|
||||
m.state = stateTable
|
||||
return m, nil
|
||||
}
|
||||
}
|
||||
return m, nil
|
||||
}
|
||||
|
||||
// ── View ────────────────────────────────────────────────────────────
|
||||
|
||||
func (m model) View() string {
|
||||
var b strings.Builder
|
||||
|
||||
// Title bar
|
||||
title := titleStyle.Render(" GGUF Editor ")
|
||||
fname := infoStyle.Render(filepath.Base(m.filePath))
|
||||
ver := infoStyle.Render(fmt.Sprintf("v%d", m.gguf.Version))
|
||||
dirtyMark := ""
|
||||
if m.dirty {
|
||||
dirtyMark = modifiedStyle.Render(" [modified]")
|
||||
}
|
||||
b.WriteString(title + " " + fname + " " + ver + dirtyMark + "\n\n")
|
||||
|
||||
// Table
|
||||
b.WriteString(m.table.View())
|
||||
b.WriteString("\n\n")
|
||||
|
||||
// Status line
|
||||
if m.statusIsErr {
|
||||
b.WriteString(statusErrStyle.Render(" " + m.statusMsg))
|
||||
} else {
|
||||
b.WriteString(statusOkStyle.Render(" " + m.statusMsg))
|
||||
}
|
||||
b.WriteString("\n")
|
||||
|
||||
// Help bar
|
||||
help := " e/Enter:edit a:add d:delete s:save q:quit"
|
||||
b.WriteString(helpStyle.Render(help))
|
||||
|
||||
view := b.String()
|
||||
|
||||
// Overlay rendering
|
||||
switch m.state {
|
||||
case stateEdit:
|
||||
kv := m.gguf.Metadata[m.editIdx]
|
||||
overlay := overlayTitleStyle.Render(fmt.Sprintf("Edit: %s (%s)", kv.Key, kv.Value.TypeName())) +
|
||||
"\n" + m.editInput.View() +
|
||||
"\n\n" + dimStyle.Render("Enter: save Esc: cancel")
|
||||
view = m.renderOverlay(view, overlay)
|
||||
case stateAdd:
|
||||
var overlay string
|
||||
switch m.addStep {
|
||||
case 0:
|
||||
overlay = overlayTitleStyle.Render("Add Metadata: Enter Key") +
|
||||
"\n" + m.addInput.View() +
|
||||
"\n\n" + dimStyle.Render("Enter: next Esc: cancel")
|
||||
case 1:
|
||||
overlay = overlayTitleStyle.Render(fmt.Sprintf("Add: %s - Select Type", m.addKey)) +
|
||||
"\n" + m.renderTypePicker() +
|
||||
"\n\n" + dimStyle.Render("Left/Right: select Enter: next Esc: cancel")
|
||||
case 2:
|
||||
overlay = overlayTitleStyle.Render(fmt.Sprintf("Add: %s (%s) - Enter Value", m.addKey, ScalarTypes[m.addType])) +
|
||||
"\n" + m.addInput.View() +
|
||||
"\n\n" + dimStyle.Render("Enter: add Esc: cancel")
|
||||
}
|
||||
view = m.renderOverlay(view, overlay)
|
||||
case stateConfirm:
|
||||
overlay := overlayTitleStyle.Render(m.confirmMsg) +
|
||||
"\n\n" + dimStyle.Render("y/Enter: yes n/Esc: no")
|
||||
view = m.renderOverlay(view, overlay)
|
||||
}
|
||||
|
||||
return view
|
||||
}
|
||||
|
||||
func (m model) renderTypePicker() string {
|
||||
var parts []string
|
||||
for i, t := range ScalarTypes {
|
||||
if i == m.addType {
|
||||
parts = append(parts, typeActiveStyle.Render(t.String()))
|
||||
} else {
|
||||
parts = append(parts, typeInactiveStyle.Render(t.String()))
|
||||
}
|
||||
}
|
||||
// Wrap into rows of ~6
|
||||
var rows []string
|
||||
for i := 0; i < len(parts); i += 6 {
|
||||
end := i + 6
|
||||
if end > len(parts) {
|
||||
end = len(parts)
|
||||
}
|
||||
rows = append(rows, strings.Join(parts[i:end], " "))
|
||||
}
|
||||
return strings.Join(rows, "\n")
|
||||
}
|
||||
|
||||
func (m model) renderOverlay(base, content string) string {
|
||||
box := overlayStyle.Render(content)
|
||||
boxLines := strings.Split(box, "\n")
|
||||
baseLines := strings.Split(base, "\n")
|
||||
|
||||
// Center the overlay vertically and horizontally
|
||||
startY := (m.height - len(boxLines)) / 2
|
||||
if startY < 0 {
|
||||
startY = 0
|
||||
}
|
||||
startX := (m.width - lipgloss.Width(box)) / 2
|
||||
if startX < 0 {
|
||||
startX = 0
|
||||
}
|
||||
|
||||
// Dim the base
|
||||
for i := range baseLines {
|
||||
baseLines[i] = dimStyle.Render(stripAnsi(baseLines[i]))
|
||||
}
|
||||
|
||||
// Overlay the box
|
||||
for i, line := range boxLines {
|
||||
row := startY + i
|
||||
if row >= 0 && row < len(baseLines) {
|
||||
padded := baseLines[row]
|
||||
if startX > lipgloss.Width(padded) {
|
||||
padded += strings.Repeat(" ", startX-lipgloss.Width(padded))
|
||||
}
|
||||
// Replace the section
|
||||
baseLines[row] = truncateToWidth(padded, startX) + line
|
||||
}
|
||||
}
|
||||
|
||||
return strings.Join(baseLines, "\n")
|
||||
}
|
||||
|
||||
// ── Helpers ─────────────────────────────────────────────────────────
|
||||
|
||||
func (m *model) rebuildRows() {
|
||||
cur := m.table.Cursor()
|
||||
m.table = m.buildTable(m.width, m.height)
|
||||
if cur >= len(m.gguf.Metadata) {
|
||||
cur = len(m.gguf.Metadata) - 1
|
||||
}
|
||||
if cur < 0 {
|
||||
cur = 0
|
||||
}
|
||||
m.table.SetCursor(cur)
|
||||
}
|
||||
|
||||
func (m model) outputPath() string {
|
||||
dir := filepath.Dir(m.filePath)
|
||||
base := filepath.Base(m.filePath)
|
||||
return filepath.Join(dir, "modified_"+base)
|
||||
}
|
||||
|
||||
// stripAnsi removes ANSI escape sequences for width calculations.
|
||||
func stripAnsi(s string) string {
|
||||
var b strings.Builder
|
||||
inEsc := false
|
||||
for _, r := range s {
|
||||
if r == '\033' {
|
||||
inEsc = true
|
||||
continue
|
||||
}
|
||||
if inEsc {
|
||||
if (r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z') {
|
||||
inEsc = false
|
||||
}
|
||||
continue
|
||||
}
|
||||
b.WriteRune(r)
|
||||
}
|
||||
return b.String()
|
||||
}
|
||||
|
||||
// truncateToWidth takes the first n visible characters of a string,
|
||||
// preserving any ANSI escapes that precede them.
|
||||
func truncateToWidth(s string, n int) string {
|
||||
var b strings.Builder
|
||||
visible := 0
|
||||
inEsc := false
|
||||
for _, r := range s {
|
||||
if visible >= n && !inEsc {
|
||||
break
|
||||
}
|
||||
b.WriteRune(r)
|
||||
if r == '\033' {
|
||||
inEsc = true
|
||||
continue
|
||||
}
|
||||
if inEsc {
|
||||
if (r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z') {
|
||||
inEsc = false
|
||||
}
|
||||
continue
|
||||
}
|
||||
visible++
|
||||
}
|
||||
// Pad if needed
|
||||
for visible < n {
|
||||
b.WriteByte(' ')
|
||||
visible++
|
||||
}
|
||||
return b.String()
|
||||
}
|
||||
|
||||
func max(a, b int) int {
|
||||
if a > b {
|
||||
return a
|
||||
}
|
||||
return b
|
||||
}
|
||||
|
||||
// ── Main ────────────────────────────────────────────────────────────
|
||||
|
||||
func main() {
|
||||
if len(os.Args) < 2 {
|
||||
fmt.Fprintf(os.Stderr, "Usage: %s <file.gguf>\n", os.Args[0])
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
path := os.Args[1]
|
||||
g, err := ParseGGUF(path)
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
absPath, err := filepath.Abs(path)
|
||||
if err != nil {
|
||||
absPath = path
|
||||
}
|
||||
|
||||
m := initialModel(g, absPath)
|
||||
p := tea.NewProgram(m, tea.WithAltScreen())
|
||||
if _, err := p.Run(); err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user