Initial commit
This commit is contained in:
commit
cec58d1a39
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://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.
|
||||
|
||||
Spellchecker agnostic autocorrection
|
||||
Copyright (C) 2024 TEC
|
||||
|
||||
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 <http://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
|
||||
<http://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
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
|
@ -0,0 +1,138 @@
|
|||
#+title: Autocorrect
|
||||
#+subtitle: Spellchecker-agnostic autocorrect for Emacs
|
||||
#+author: tecosaur
|
||||
|
||||
Automatically build an autocorrection =abbrev= table that fixes misspellings and
|
||||
typos on-the-fly.
|
||||
|
||||
Compared to simply adding a correction to the global abbrev table whenever a
|
||||
correction is made, =autocorrect=:
|
||||
+ Allows setting a minimum number of occurrences before a correction becomes
|
||||
automatic, both on an all-time level and within the current session.
|
||||
+ Manages its abbrev table independently of the user abbrev tables
|
||||
+ Allows multiple Emacs sessions to all contribute to the same autocorrection
|
||||
list, without race conditions
|
||||
+ Makes combining autocorrect data across machines easy: just concatenate the
|
||||
autocorrect data files
|
||||
+ Recognises that some but not all words are the same in upper and lower case.
|
||||
For example "teh" and "Teh" should become "the" and "The" respectively, but
|
||||
only "Bayex" should become "Bayeux".
|
||||
+ Allows certain words to be ignored, i.e. never be autocorrected
|
||||
|
||||
* Activation
|
||||
|
||||
Some time soon after startup, run ~autocorrect-setup~. I like to do this with an
|
||||
idle timer.
|
||||
|
||||
#+begin_src emacs-lisp
|
||||
(run-with-idle-timer 0.5 nil #'autocorrect-setup)
|
||||
#+end_src
|
||||
|
||||
Remember to hook up the spell checker you're using, make sure =abbrev= mode is on,
|
||||
and you're good to go.
|
||||
|
||||
* Spellchecker integration
|
||||
** Generic
|
||||
|
||||
=autocorrect= needs to be told when a spelling correction has been made. This
|
||||
should be done through the function ~autocorrect-record-correction~.
|
||||
|
||||
At a bare minimum, just invoking ~autocorrect-record-correction~ appropriately
|
||||
will make =autocorrect= start working, however there are two more optional steps
|
||||
to integration that can enhance the experience.
|
||||
1. Set ~autocorrect-check-spelling-function~ so that letter casing is handled a bit better
|
||||
2. Set ~autocorrect-predicates~ to control where corrections can occur
|
||||
|
||||
** Jinx
|
||||
|
||||
#+begin_src emacs-lisp
|
||||
(defun autocorrect-jinx-record-correction (overlay corrected)
|
||||
"Record that Jinx corrected the text in OVERLAY to CORRECTED."
|
||||
(let ((text
|
||||
(buffer-substring-no-properties
|
||||
(overlay-start overlay)
|
||||
(overlay-end overlay))))
|
||||
(autocorrect-record-correction text corrected)))
|
||||
|
||||
(defun autocorrect-jinx-check-spelling (word)
|
||||
"Check if WORD is valid."
|
||||
;; A copy of `jinx--word-valid-p', just without the buffer substring.
|
||||
;; It would have been nice if `jinx--word-valid-p' war implemented as this
|
||||
;; function with `jinx--this-word-valid-p' (or similar) as the at-point variant.
|
||||
(or (member word jinx--session-words)
|
||||
;; Allow capitalized words
|
||||
(and (string-match-p "\\`[[:upper:]][[:lower:]]+\\'" word)
|
||||
(cl-loop
|
||||
for w in jinx--session-words
|
||||
thereis (and (string-equal-ignore-case word w)
|
||||
(string-match-p "\\`[[:lower:]]+\\'" w))))
|
||||
(cl-loop for dict in jinx--dicts
|
||||
thereis (jinx--mod-check dict word))))
|
||||
|
||||
(defun autocorrect-jinx-appropriate (pos)
|
||||
"Return non-nil if it is appropriate to spellcheck at POS according to jinx."
|
||||
(and (not (jinx--face-ignored-p pos))
|
||||
(not (jinx--regexp-ignored-p pos))))
|
||||
|
||||
(setq autocorrect-check-spelling-function #'autocorrect-jinx-check-spelling)
|
||||
(add-to-list 'autocorrect-predicates #'autocorrect-jinx-appropriate)
|
||||
(advice-add 'jinx--correct-replace :before #'autocorrect-jinx-record-correction)
|
||||
#+end_src
|
||||
|
||||
** Flyspell
|
||||
|
||||
#+begin_src emacs-lisp
|
||||
(defvar-local autocorrect-flyspell-misspelling)
|
||||
|
||||
(defun autocorrect-flyspell-insert (word)
|
||||
"Insert WORD and record the correction with autocorrect.el."
|
||||
(autocorrect-record-correction
|
||||
(or autocorrect-flyspell-misspelling flyspell-auto-correct-word)
|
||||
word)
|
||||
(insert word))
|
||||
|
||||
(defun autocorrect--flyspell-do-correct-a (oldfun replace poss word cursor-location start end save)
|
||||
"Wraps `flyspell-do-correct' to store the word it's correcting."
|
||||
(let ((autocorrect-flyspell-misspelling word))
|
||||
(funcall oldfun replace poss word cursor-location start end save)))
|
||||
|
||||
(setq flyspell-insert-function autocorrect-flyspell-insert)
|
||||
(advice-add 'flyspell-do-correct :around #'autocorrect--flyspell-do-correct-a)
|
||||
#+end_src
|
||||
|
||||
* Why use autocorrection?
|
||||
|
||||
If you want to write without looking like you skipped a chunk of
|
||||
primary/secondary school (as I do), then autocorrect is a handy thing to have.
|
||||
Beyond just misspellings, it can also help with typos, and lazy capitalisation
|
||||
(can you really be bothered to consistently type "LuaLaTeX" instead of
|
||||
"lualatex" and "SciFi" over "scifi"?). However, primarily thanks to smartphones,
|
||||
I more often hear people cursing autocorrect than praising it. With that in
|
||||
mind, I think it's worth giving some thought to how smartphone autocorrect gets
|
||||
its bad reputation (despite largely doing a decent job):
|
||||
1. Typing is harder on smartphones, and so autocorrect makes bigger (more speculative) guesses
|
||||
2. People type (and mistype) differently, but autocorrect tries to have a "one
|
||||
size fits all" profile that is refined over time
|
||||
3. As soon as you accept a particular correction, autocorrect can start applying
|
||||
that even when the original typo is ambiguous and has multiple "corrected" forms
|
||||
4. It's hard to tell the phone to stop doing a particular autocorrect (see
|
||||
"Emacs" recapitalised as "eMacs" on Apple devices)
|
||||
|
||||
I think we can largely alleviate these problems by
|
||||
1. Being mainly used on devices with actual keyboards
|
||||
2. Starting with an empty autocorrect "profile", built up by the user over time
|
||||
3. Having a customisable threshold before a repeated correction is made into an
|
||||
autocorrection, and blacklisting misspellings with multiple distinct corrections.
|
||||
4. Making it easy to blacklist certain words from becoming autocorrections
|
||||
|
||||
Another complaint about autocorrect is that it lets you develop bad habits, and
|
||||
if anything a tool that got you to retype the correct spelling several times
|
||||
would be more valuable in the long run. I think this is a pretty reasonable
|
||||
complaint, and have two different trains of thought that both justify tracking
|
||||
corrections made:
|
||||
+ I almost never leave Emacs for writing more than a text message, so what if I
|
||||
type worse outside of it?
|
||||
+ By tracking corrections made, you can also make a personal "most common
|
||||
misspellings" training list to run through at your leasure or when committing
|
||||
a misspelling. Just set the "minimum replacement count" to a stupidly high
|
||||
number and optionally make use of ~autocorrect-post-correct-hook~.
|
|
@ -0,0 +1,632 @@
|
|||
;;; autocorrect.el --- Spellchecker agnostic autocorrection -*- lexical-binding: t; -*-
|
||||
;;
|
||||
;; Copyright (C) 2024 TEC
|
||||
;;
|
||||
;; Author: TEC <contact@tecosaur.net>
|
||||
;; Maintainer: TEC <contact@tecosaur.net>
|
||||
;; Created: March 27, 2024
|
||||
;; Modified: March 27, 2024
|
||||
;; Version: 0.1.0
|
||||
;; Keywords: convenience, text
|
||||
;; Homepage: https://code.tecosaur.net/tec/autocorrect.el
|
||||
;; Package-Requires: ((emacs "29.1"))
|
||||
;;
|
||||
;; This file is not part of GNU Emacs.
|
||||
;;
|
||||
;;; Commentary:
|
||||
;;
|
||||
;; Spellchecker agnostic autocorrect in Emacs
|
||||
;;
|
||||
;;; Code:
|
||||
|
||||
(eval-when-compile
|
||||
(require 'subr-x))
|
||||
|
||||
(require 'abbrev)
|
||||
|
||||
(defgroup autocorrect nil
|
||||
"Automatically fix typos and frequent spelling mistakes."
|
||||
:group 'text
|
||||
:prefix "autocorrect-")
|
||||
|
||||
;;;; Customisation variables:
|
||||
|
||||
;; To record corrections made, we can just use a simple text file.
|
||||
;;
|
||||
;; For simplicity of operation, I think we can just append each correction the
|
||||
;; file as "misspelled corrected" lines. This has a number of advantages, such
|
||||
;; as avoiding recalculations while typing, avoiding race conditions with
|
||||
;; multiple Emacs sessions, and making merging data on different machines
|
||||
;; trivial.
|
||||
;;
|
||||
;; In the Emacs session though, I think we'll want to have a hash table of the
|
||||
;; counts of each correction. We can have the misspelled words as the keys, and
|
||||
;; then have each value be an alist of ~(correction . count)~ pairs. This table
|
||||
;; can be lazily built and processed after startup.
|
||||
|
||||
(defcustom autocorrect-file
|
||||
(file-name-concat (or (getenv "XDG_STATE_HOME") "~/.local/state")
|
||||
"emacs" "autocorrections.txt")
|
||||
"File where a record of spell checks and autocorrections is saved.
|
||||
Each line of this file is of the form:
|
||||
|
||||
MISSPELLING [MANUAL-CORRECTION-COUNT AUTOCORRECTION-COUNT] CORRECTED
|
||||
|
||||
Where MANUAL-CORRECTION-COUNT and AUTOCORRECTION-COUNT are
|
||||
optional (indicated by the brackets)."
|
||||
:type 'file)
|
||||
|
||||
;; We probably want to also specify a threshold number of misspellings that
|
||||
;; trigger entry to the abbrev table, both on load and when made during the
|
||||
;; current Emacs session. For now, I'll try a value of three for on-load and two
|
||||
;; for misspellings made in the current Emacs session. I think I want to avoid a
|
||||
;; value of one since that makes it easy for a misspelling with multiple valid
|
||||
;; corrections to become associated with a single correction too soon. This is a
|
||||
;; rare concern, but it would be annoying enough to run into that I think it's
|
||||
;; worth requiring a second misspelling.
|
||||
|
||||
(defcustom autocorrect-count-threshold-alltime 3
|
||||
"The number of recorded identical misspellings to create an abbrev.
|
||||
This applies to misspellings read from `autocorrect-file'."
|
||||
:type 'natnum)
|
||||
|
||||
(defcustom autocorrect-count-threshold-session 2
|
||||
"The number of identical misspellings to create an abbrev.
|
||||
This applies to misspellings made in the current Emacs session."
|
||||
:type 'natnum)
|
||||
|
||||
;; It's probably not sensible to do autocorrection anywhere,
|
||||
;; and predicate functions are a flexible way of allowing this to be specified.
|
||||
(defcustom autocorrect-predicates nil
|
||||
"Predicate functions called at point with argument START.
|
||||
These functions should return t if autocorrection is valid at START."
|
||||
:type '(repeat function))
|
||||
|
||||
(defcustom autocorrect-post-correct-hook nil
|
||||
"Hook run after an autocorrection has occurred.
|
||||
Each function is called with two arguments, the original misspelling and the
|
||||
correction inserted.
|
||||
|
||||
In some cases (when the correction consists of multiple words), it is not
|
||||
possible to determine this information and this hook will not be run.
|
||||
This limitation stems from the how abbrev implements post-insertion hooks."
|
||||
:type 'hook)
|
||||
|
||||
;; When we handle just-performed spelling corrections, if the word is capitalised
|
||||
;; it could either be because:
|
||||
;; - It is appearing at the start of the sentence
|
||||
;; - It is a proper noun, and should always be capitalised
|
||||
;;
|
||||
;; We want to differentiate these two cases, which we can do by converting the
|
||||
;; corrected word to lowercase and testing whether that form is spellchecked as
|
||||
;; correct.
|
||||
(defcustom autocorrect-check-spelling-function nil
|
||||
"Predicate function that indicates whether a word is correctly spelled.
|
||||
This is used to check whether a correction can be safely lowercased."
|
||||
:type '(choice function (const nil)))
|
||||
|
||||
(defcustom autocorrect-child-abbrev-tables '(text-mode-abbrev-table prog-mode-abbrev-table)
|
||||
"List of abbrev tables that autocorrect should insert itself as a parent of.
|
||||
Must be set before `autocorrect-setup' is first called to take effect."
|
||||
:type '(repeat variable))
|
||||
|
||||
;;;; Internal variables:
|
||||
|
||||
(defvar autocorrect--table (make-hash-table :test #'equal)
|
||||
"A record of all corrections made, generated from `autocorrect-file'.
|
||||
Misspelled words are the keys, and a alist of corrections and their counts are
|
||||
the values.")
|
||||
|
||||
(defvar autocorrect--abbrev-table nil
|
||||
"The spelling abbrev table.")
|
||||
|
||||
(defvar autocorrect--abbrev-table-saved-version 0
|
||||
"The version of `autocorrect--abbrev-table' saved to disk.")
|
||||
|
||||
(defvar autocorrect--file-mtime (seconds-to-time 0)
|
||||
"The mtime of `autocorrect-file' last time it was looked at.")
|
||||
|
||||
(defvar autocorrect--should-update-savefile nil
|
||||
"Indicator for whether there are any changes that should be written on save.")
|
||||
|
||||
;;;; Minor mode:
|
||||
|
||||
;;;###autoload
|
||||
(define-minor-mode autocorrect-mode
|
||||
"Automatically correct misspellings with abbrev."
|
||||
:init-value t)
|
||||
|
||||
;;;###autoload
|
||||
(define-globalized-minor-mode global-autocorrect-mode
|
||||
autocorrect-mode autocorrect--enable)
|
||||
|
||||
(defun autocorrect--enable ()
|
||||
"Turn on `autocorrect-mode' in the current buffer."
|
||||
(autocorrect-mode 1))
|
||||
|
||||
;;;; Utility functions:
|
||||
|
||||
(defun autocorrect--appropriate-p ()
|
||||
"Return non-nil it is currently appropriate to make an autocorrection.
|
||||
See `autocorrect-predicates'."
|
||||
(and autocorrect-mode
|
||||
(run-hook-with-args-until-failure 'autocorrect-predicates (point))))
|
||||
|
||||
(defun autocorrect--run-post-correct-hook ()
|
||||
"Determine the correction, and run `autocorrect-post-correct-hook'.
|
||||
It is expected that this is run as a post-abbrev hook within `abbrev-insert'.
|
||||
This assumption allows us to determine the newly inserted correction, so long as
|
||||
it is a single word, and then perform a reverse lookup of `autocorrect--table'
|
||||
to find the original misspelling."
|
||||
(when autocorrect-post-correct-hook
|
||||
(let ((correction (substring-no-properties (thing-at-point 'word)))
|
||||
misspelling)
|
||||
(maphash
|
||||
(lambda (misp corrections)
|
||||
(unless misspelling
|
||||
(when (equal (caar corrections) correction)
|
||||
(setq misspelling misp))))
|
||||
autocorrect--table)
|
||||
(when misspelling
|
||||
(run-hook-with-args 'autocorrect-post-correct-hook
|
||||
misspelling correction)))))
|
||||
|
||||
(defun autocorrect--capitalised-or-uppercase-p (word)
|
||||
"Return t if WORD is of form \"Capitalised\" or \"UPPERCASE\"."
|
||||
(and (not (string-empty-p word))
|
||||
(char-uppercase-p (aref word 0))
|
||||
;; To check whether a function is indeed lowercase we'll try using
|
||||
;; ~char-uppercase-p~ instead of Regexp for speed (I think but haven't
|
||||
;; tested that this will be faster).
|
||||
(let ((letter-cases (mapcar #'char-uppercase-p word)))
|
||||
(or (not (memq t (cdr letter-cases)))
|
||||
(not (memq nil (cdr letter-cases)))))))
|
||||
|
||||
(defun autocorrect--should-downcase-p (misspelling corrected)
|
||||
"Check whether it is a good idea to `downcase' MISSPELLING and CORRECTED.
|
||||
This is conditional on all of the following being true:
|
||||
- MISSPELLING satisfies `autocorrect--capitalised-or-uppercase-p'
|
||||
- CORRECTED satisfies `autocorrect--capitalised-or-uppercase-p'
|
||||
- The lowercase form of CORRECTED satisfies
|
||||
`autocorrect-check-spelling-function'"
|
||||
(and autocorrect-check-spelling-function
|
||||
(autocorrect--capitalised-or-uppercase-p misspelling)
|
||||
(autocorrect--capitalised-or-uppercase-p corrected)
|
||||
(funcall autocorrect-check-spelling-function
|
||||
(downcase corrected))))
|
||||
|
||||
(defun autocorrect--update-table (misspelling corrected &optional manual-count auto-count)
|
||||
"Update the MISSPELLING to CORRECTED entry in the table.
|
||||
|
||||
Unless specified, it is assumed that MANUAL-COUNT is 1 and
|
||||
AUTO-COUNT is 0, referring to the number of times MISSPELLING has
|
||||
been manually and automatically corrected to CORRECTED
|
||||
respectively."
|
||||
(let* ((correction-counts
|
||||
(gethash misspelling autocorrect--table))
|
||||
(record-cons
|
||||
(assoc corrected correction-counts))
|
||||
(manual-count (or manual-count 1))
|
||||
(auto-count (or auto-count 0)))
|
||||
(if record-cons
|
||||
(setcdr record-cons
|
||||
(cons (+ (cadr record-cons) manual-count)
|
||||
(+ (cddr record-cons) auto-count)))
|
||||
(puthash misspelling
|
||||
(let ((cinfo (cons corrected (cons manual-count auto-count))))
|
||||
(if correction-counts
|
||||
(push cinfo correction-counts)
|
||||
(list cinfo)))
|
||||
autocorrect--table))))
|
||||
|
||||
(defun autocorrect--write-to-file (&optional content append)
|
||||
"Write the string CONTENT or the current buffer to `autocorrect-file'.
|
||||
APPEND is passed through to `write-region'."
|
||||
(let ((write-region-inhibit-fsync t) ; Quicker writes, not needed
|
||||
(coding-system-for-write 'utf-8)
|
||||
(inhibit-message t))
|
||||
(write-region content nil autocorrect-file append)))
|
||||
|
||||
;;;; Abbrev management:
|
||||
|
||||
(defun autocorrect--set-abbrev (misspelling corrected)
|
||||
"Create an abbrev from MISSPELLING to CORRECTED in `autocorrect--abbrev-table'."
|
||||
(let ((sym (obarray-put autocorrect--abbrev-table misspelling)))
|
||||
(unless (and (boundp sym) (equal (symbol-value sym) corrected))
|
||||
(set sym corrected)
|
||||
(fset sym #'autocorrect--run-post-correct-hook)
|
||||
(setplist sym (list :count 0 :system t))
|
||||
(abbrev-table-put
|
||||
autocorrect--abbrev-table :abbrev-table-modiff
|
||||
(1+ (abbrev-table-get autocorrect--abbrev-table :abbrev-table-modiff))))))
|
||||
|
||||
(defun autocorrect--unset-abbrev (misspelling)
|
||||
"Remove any abbrevs associated with MISSPELLING in `autocorrect--abbrev-table'."
|
||||
(let ((sym (obarray-get autocorrect--abbrev-table misspelling)))
|
||||
(when sym (obarray-remove autocorrect--abbrev-table sym))))
|
||||
|
||||
(defun autocorrect--setup-abbrevs ()
|
||||
"Setup `autocorrect--abbrev-table'.
|
||||
Also set it as a parent of `global-abbrev-table'."
|
||||
(unless autocorrect--abbrev-table
|
||||
(setq autocorrect--abbrev-table
|
||||
(make-abbrev-table (list :enable-function #'autocorrect--appropriate-p)))
|
||||
(dolist (child-abbrev-table (mapcar #'symbol-value autocorrect-child-abbrev-tables))
|
||||
(abbrev-table-put
|
||||
child-abbrev-table :parents
|
||||
(cons autocorrect--abbrev-table
|
||||
(abbrev-table-get child-abbrev-table :parents))))))
|
||||
|
||||
(defun autocorrect--create-abbrevs ()
|
||||
"Apply the history threshold to the current correction table."
|
||||
(maphash
|
||||
(lambda (misspelling corrections)
|
||||
(when (and (= (length corrections) 1)
|
||||
(>= (cadar corrections)
|
||||
autocorrect-count-threshold-alltime))
|
||||
(autocorrect--set-abbrev misspelling (caar corrections))))
|
||||
autocorrect--table))
|
||||
|
||||
(defun autocorrect--transfer-abbrev-counts-to-table ()
|
||||
"Transfer autocorrect counts from the abbrev table to the record table.
|
||||
More specifically, this finds all entries of `autocorrect--abbrev-table'
|
||||
with a non-zero :count field, adds that value to the autocorrect count via
|
||||
`autocorrect--update-table', and zeros the :count field."
|
||||
(let (symbols)
|
||||
(mapatoms
|
||||
(lambda (sym)
|
||||
(push sym symbols))
|
||||
autocorrect--abbrev-table)
|
||||
(dolist (sym symbols)
|
||||
(when (and (gethash (symbol-name sym) autocorrect--table)
|
||||
(> (get sym :count) 0))
|
||||
(autocorrect--update-table
|
||||
(symbol-name sym) (symbol-value sym)
|
||||
0 (get sym :count))
|
||||
(put sym :count 0)))))
|
||||
|
||||
(defun autocorrect--remove-invalid-abbrevs ()
|
||||
"Remove entries of `autocorrect--abbrev-table' not in `autocorrect--table'."
|
||||
(mapatoms
|
||||
(lambda (symb)
|
||||
(when (symbol-value symb)
|
||||
(let ((misspelling (symbol-name symb)))
|
||||
(let ((corrections (gethash misspelling autocorrect--table)))
|
||||
(unless (and (= (length corrections) 1)
|
||||
(>= (cadar corrections)
|
||||
autocorrect-count-threshold-alltime))
|
||||
(obarray-remove autocorrect--abbrev-table symb))))))
|
||||
autocorrect--abbrev-table))
|
||||
|
||||
(defun autocorrect--sync-abbrevs ()
|
||||
"Synchronise `autocorrect--abbrev-table' with `autocorrect--table'."
|
||||
(autocorrect--remove-invalid-abbrevs)
|
||||
(autocorrect--create-abbrevs))
|
||||
|
||||
;;;; History management:
|
||||
|
||||
(defun autocorrect--read ()
|
||||
"Read `autocorrect-file' into the correction table."
|
||||
(unless (hash-table-empty-p autocorrect--table)
|
||||
(setq autocorrect--table (make-hash-table :test #'equal)))
|
||||
(if (file-exists-p autocorrect-file)
|
||||
(with-temp-buffer
|
||||
(insert-file-contents autocorrect-file)
|
||||
(setq autocorrect--file-mtime
|
||||
(file-attribute-modification-time (file-attributes autocorrect-file)))
|
||||
(goto-char (point-min))
|
||||
(let ((pt (point))
|
||||
misspelling next-word
|
||||
manual-count auto-count
|
||||
corrected)
|
||||
(while (< (point) (point-max))
|
||||
(setq misspelling
|
||||
(and (forward-word)
|
||||
(buffer-substring pt (point)))
|
||||
pt (1+ (point)))
|
||||
(setq next-word
|
||||
(or (and (forward-word)
|
||||
(buffer-substring pt (point)))
|
||||
""))
|
||||
(setq manual-count (string-to-number next-word))
|
||||
(if (and (= manual-count 0) (not (string= next-word "0")))
|
||||
(setq corrected
|
||||
(if (eolp) next-word (buffer-substring pt (pos-eol)))
|
||||
manual-count 1
|
||||
auto-count 0)
|
||||
(setq pt (1+ (point))
|
||||
next-word
|
||||
(or (and (forward-word)
|
||||
(buffer-substring pt (point)))
|
||||
""))
|
||||
(setq auto-count (string-to-number next-word)
|
||||
corrected
|
||||
(if (and (= auto-count 0) (not (string= next-word "0")))
|
||||
(if (eolp) next-word (buffer-substring pt (pos-eol)))
|
||||
(buffer-substring (min (1+ (point)) (pos-eol))
|
||||
(pos-eol)))))
|
||||
(forward-line 1)
|
||||
(setq pt (point))
|
||||
(when (and misspelling corrected)
|
||||
(autocorrect--update-table
|
||||
misspelling corrected manual-count auto-count)))))
|
||||
(make-directory (file-name-directory autocorrect-file))
|
||||
(write-region "" nil autocorrect-file)))
|
||||
|
||||
(defun autocorrect--write ()
|
||||
"Write the current `autocorrect--table' to `autocorrect-file'."
|
||||
(with-temp-buffer
|
||||
(maphash
|
||||
(lambda (misspelling corrections)
|
||||
(dolist (correction corrections)
|
||||
(insert misspelling
|
||||
" " (number-to-string (cadr correction))
|
||||
" " (number-to-string (cddr correction))
|
||||
" " (car correction)
|
||||
"\n")))
|
||||
autocorrect--table)
|
||||
(autocorrect--write-to-file)
|
||||
(setq autocorrect--file-mtime
|
||||
(file-attribute-modification-time (file-attributes autocorrect-file)))))
|
||||
|
||||
;;;; List UI
|
||||
|
||||
(defvar autocorrect--list-format
|
||||
`[("Misspelling" 16
|
||||
,(lambda (a b)
|
||||
(string< (aref (cadr a) 0) (aref (cadr b) 0))))
|
||||
(" → " 4
|
||||
,(lambda (a b)
|
||||
(let ((a-face (car (alist-get 'face (list (text-properties-at 1 (aref (cadr a) 1))))))
|
||||
(b-face (car (alist-get 'face (list (text-properties-at 1 (aref (cadr b) 1))))))
|
||||
(face-priorities '(error default shadow)))
|
||||
(< (length (memq a-face face-priorities))
|
||||
(length (memq b-face face-priorities))))))
|
||||
("Correction" 16
|
||||
,(lambda (a b)
|
||||
(string< (aref (cadr a) 2) (aref (cadr b) 2))))
|
||||
("#Manual" 8
|
||||
,(lambda (a b)
|
||||
(< (string-to-number (aref (cadr a) 3))
|
||||
(string-to-number (aref (cadr b) 3))))
|
||||
:right-align t)
|
||||
("#Auto" 6
|
||||
,(lambda (a b)
|
||||
(< (string-to-number (aref (cadr a) 4))
|
||||
(string-to-number (aref (cadr b) 4))))
|
||||
:right-align t)]
|
||||
"Table format for the error list.")
|
||||
|
||||
(defun autocorrect--list-entries ()
|
||||
"Generated a list of current autocorrections for `autocorrect-list-mode'."
|
||||
(let ((misspelled-col-width 12)
|
||||
(corrected-col-width 12)
|
||||
entries)
|
||||
(maphash
|
||||
(lambda (misspelling corrections)
|
||||
(setq misspelled-col-width (max misspelled-col-width (length misspelling)))
|
||||
(let ((active-abbrev (obarray-get autocorrect--abbrev-table misspelling))
|
||||
(ignored-p (member "" (mapcar #'car corrections)))
|
||||
(ambiguous-p (> (length corrections) 1))
|
||||
(session-only-p
|
||||
(and (= 1 (length corrections))
|
||||
(> autocorrect-count-threshold-alltime (cadar corrections))
|
||||
(>= (cadar corrections) autocorrect-count-threshold-session))))
|
||||
(when (and active-abbrev (not (symbol-value active-abbrev)))
|
||||
(setq active-abbrev nil))
|
||||
(dolist (correction corrections)
|
||||
(setq corrected-col-width (max corrected-col-width (length (car correction))))
|
||||
(push (list (cons misspelling correction)
|
||||
(vector
|
||||
(if (and ambiguous-p (not ignored-p))
|
||||
(concat misspelling " "
|
||||
(propertize (format "(%d)"
|
||||
(- (length corrections)
|
||||
(length (assoc (car correction) corrections))))
|
||||
'face 'shadow))
|
||||
(propertize misspelling
|
||||
'face (if ignored-p 'shadow 'default)))
|
||||
(concat
|
||||
" "
|
||||
(cond
|
||||
(active-abbrev "→")
|
||||
(ignored-p (propertize "→" 'face 'error))
|
||||
(t (propertize "→" 'face 'shadow))))
|
||||
(if (string-empty-p (car correction))
|
||||
(propertize "ignore flag" 'face '(shadow italic))
|
||||
(propertize (car correction) 'face 'success))
|
||||
(if (string-empty-p (car correction))
|
||||
(propertize "-" 'face 'shadow)
|
||||
(propertize
|
||||
(number-to-string (cadr correction))
|
||||
'face
|
||||
(cond
|
||||
(session-only-p
|
||||
'warning)
|
||||
(active-abbrev
|
||||
'font-lock-number-face)
|
||||
(t 'shadow))))
|
||||
(let ((auto-count
|
||||
(+ (cddr correction)
|
||||
(if active-abbrev
|
||||
(get active-abbrev :count)
|
||||
0))))
|
||||
(if (and (= auto-count 0)
|
||||
(not active-abbrev))
|
||||
(propertize "-" 'face 'shadow)
|
||||
(propertize
|
||||
(number-to-string auto-count)
|
||||
'face (if (= auto-count 0)
|
||||
'shadow
|
||||
'font-lock-number-face))))))
|
||||
entries))))
|
||||
autocorrect--table)
|
||||
(setf (cadr (aref autocorrect--list-format 0)) misspelled-col-width)
|
||||
(setf (cadr (aref autocorrect--list-format 2)) corrected-col-width)
|
||||
entries))
|
||||
|
||||
(defvar-keymap autocorrect-list-mode-map
|
||||
:doc "Keymap for `autocorrect-list-mode'."
|
||||
"i" #'autocorrect-ignore-word
|
||||
"x" #'autocorrect-remove-correction
|
||||
"a" #'autocorrect-create-correction)
|
||||
|
||||
(define-derived-mode autocorrect-list-mode tabulated-list-mode
|
||||
"Autocorrections"
|
||||
"Major mode for listing autocorrections.
|
||||
|
||||
\\{autocorrect-list-mode-map}"
|
||||
(setq tabulated-list-format autocorrect--list-format
|
||||
tabulated-list-sort-key (cons "Misspelling" nil)
|
||||
tabulated-list-padding 1
|
||||
tabulated-list-entries #'autocorrect--list-entries)
|
||||
(setq-local truncate-string-ellipsis "…")
|
||||
(tabulated-list-init-header))
|
||||
|
||||
;;;; User-facing functions:
|
||||
|
||||
(defun autocorrect-list ()
|
||||
"List loaded autocorrections."
|
||||
(interactive)
|
||||
(let ((buffer (get-buffer-create "*Autocorrections*")))
|
||||
(with-current-buffer buffer
|
||||
(autocorrect-list-mode)
|
||||
(tabulated-list-print))
|
||||
(switch-to-buffer buffer)))
|
||||
|
||||
(defun autocorrect-ignore-word (word)
|
||||
"Prevent WORD from being autocorrected."
|
||||
(interactive
|
||||
(list (if (eq major-mode 'autocorrect-list-mode)
|
||||
(car (tabulated-list-get-id (point)))
|
||||
(completing-read
|
||||
"Word: " (sort (hash-table-keys autocorrect--table) #'string<)))))
|
||||
(autocorrect--update-table word "" 0 0)
|
||||
(autocorrect--unset-abbrev word)
|
||||
(autocorrect--write-to-file (concat word " 0 0\n") t)
|
||||
(when (eq major-mode 'autocorrect-list-mode)
|
||||
(tabulated-list-print t nil)))
|
||||
|
||||
(defun autocorrect-remove-correction (misspelling corrected)
|
||||
"Remove the record for MISSPELLING to CORRECTED from the autocorrect table."
|
||||
(interactive
|
||||
(if (eq major-mode 'autocorrect-list-mode)
|
||||
(let ((info (tabulated-list-get-id (point))))
|
||||
(if (yes-or-no-p
|
||||
(format
|
||||
(if (string-empty-p (cadr info))
|
||||
"Remove ignore flag from %s?"
|
||||
"Remove %s ⟶ %s?")
|
||||
(propertize (car info) 'face 'warning)
|
||||
(propertize (cadr info) 'face 'success)))
|
||||
(list (car info) (cadr info))
|
||||
(user-error "")))
|
||||
(let* ((misp-words (hash-table-keys autocorrect--table))
|
||||
(misp (completing-read "Misspelling: " (sort misp-words #'string<) nil t))
|
||||
(corrections (gethash misp autocorrect--table))
|
||||
(correction-words
|
||||
(mapcar
|
||||
(lambda (c) (if (string-empty-p (car c))
|
||||
(concat (propertize "⚑" 'face 'error) " "
|
||||
(propertize "ignore flag" 'face 'italic))
|
||||
(car c)))
|
||||
corrections))
|
||||
(crtn (completing-read "Correction: " (sort correction-words #'string<) nil t)))
|
||||
(when (equal (text-properties-at 0 crtn) '(face error))
|
||||
(setq crtn ""))
|
||||
(list misp crtn))))
|
||||
(let ((entry (gethash misspelling autocorrect--table)))
|
||||
(when entry
|
||||
(autocorrect-reload)
|
||||
(if (= 1 (length entry))
|
||||
(progn
|
||||
(remhash misspelling autocorrect--table)
|
||||
(autocorrect--unset-abbrev misspelling))
|
||||
(setq entry (delq (assoc corrected entry) entry))
|
||||
(puthash misspelling entry autocorrect--table)
|
||||
(when (= 1 (length entry))
|
||||
(autocorrect--maybe-create-abbrev misspelling (caar entry))))
|
||||
(autocorrect-save)))
|
||||
(message "Removed %s ⟶ %s"
|
||||
(propertize misspelling 'face 'warning)
|
||||
(propertize corrected 'face 'success))
|
||||
(when (eq major-mode 'autocorrect-list-mode)
|
||||
(tabulated-list-print t nil)))
|
||||
|
||||
(defun autocorrect-create-correction (misspelling corrected)
|
||||
"Create an autocorrection from MISSPELLING to CORRECTED.
|
||||
To instantly become active, we pretend that this correction has
|
||||
already been manually made as many times as needed according to
|
||||
`autocorrect-count-threshold-alltime'."
|
||||
(interactive
|
||||
(list (read-string "Misspelling: ")
|
||||
(read-string "Corrected: ")))
|
||||
(cond
|
||||
((string-empty-p misspelling)
|
||||
(user-error "Misspelling must be non-empty"))
|
||||
((string-empty-p corrected)
|
||||
(user-error "Correction must be non-empty, did you want `autocorrect-ignore-word'?")))
|
||||
(autocorrect--write-to-file
|
||||
(concat misspelling " " corrected " "
|
||||
(number-to-string autocorrect-count-threshold-alltime)
|
||||
"\n")
|
||||
t)
|
||||
(autocorrect--update-table
|
||||
misspelling corrected autocorrect-count-threshold-alltime)
|
||||
(autocorrect--maybe-create-abbrev misspelling corrected)
|
||||
(when (eq major-mode 'autocorrect-list-mode)
|
||||
(tabulated-list-print t nil)))
|
||||
|
||||
(defun autocorrect-reload ()
|
||||
"Reload `autocorrect-file' if it has changed since it was last read."
|
||||
(interactive)
|
||||
(when (time-less-p
|
||||
autocorrect--file-mtime
|
||||
(file-attribute-modification-time (file-attributes autocorrect-file)))
|
||||
(autocorrect--read)))
|
||||
|
||||
(defun autocorrect-save ()
|
||||
"Save the current autocorrect information to `autocorrect-file'."
|
||||
(interactive)
|
||||
(autocorrect-reload)
|
||||
(autocorrect--transfer-abbrev-counts-to-table)
|
||||
(autocorrect--write))
|
||||
|
||||
;;;; Spellchecker interface:
|
||||
|
||||
(defun autocorrect--maybe-create-abbrev (misspelling corrected)
|
||||
"Update the autocorrect table and possibly create an abbrev.
|
||||
The correction count for MISSPELLING to CORRECTED in the table is incremented by
|
||||
one, and should the number of corrections exceed
|
||||
`autocorrect-count-threshold-session' and there be no other recorded
|
||||
corrections, and abbrev will be created."
|
||||
(when (and (>= (or (cadr (assoc corrected (gethash misspelling autocorrect--table))) 0)
|
||||
autocorrect-count-threshold-session)
|
||||
(= 1 (length (gethash misspelling autocorrect--table))))
|
||||
(autocorrect--set-abbrev misspelling corrected)
|
||||
(message "Created new autocorrection: %s ⟶ %s"
|
||||
(propertize misspelling 'face 'warning)
|
||||
(propertize corrected 'face 'success))))
|
||||
|
||||
(defun autocorrect-record-correction (misspelling corrected)
|
||||
"Record the correction of MISSPELLING to CORRECTED."
|
||||
(when (autocorrect--should-downcase-p misspelling corrected)
|
||||
(setq misspelling (downcase misspelling)
|
||||
corrected (downcase corrected)))
|
||||
(autocorrect--write-to-file
|
||||
(concat misspelling " " corrected "\n") t)
|
||||
(autocorrect--update-table misspelling corrected)
|
||||
(autocorrect--maybe-create-abbrev misspelling corrected))
|
||||
|
||||
;;;; Setup:
|
||||
|
||||
;;;###autoload
|
||||
(defun autocorrect-setup ()
|
||||
"Read and process the history file into abbrevs."
|
||||
(autocorrect--setup-abbrevs)
|
||||
(autocorrect--read)
|
||||
(autocorrect--sync-abbrevs)
|
||||
(add-hook 'kill-emacs-hook #'autocorrect-save))
|
||||
|
||||
(provide 'autocorrect)
|
||||
;;; autocorrect.el ends here
|
Loading…
Reference in New Issue