[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/jinx 5b215b3b1c 1/2: Initial commit
From: |
ELPA Syncer |
Subject: |
[elpa] externals/jinx 5b215b3b1c 1/2: Initial commit |
Date: |
Sun, 26 Mar 2023 09:58:05 -0400 (EDT) |
branch: externals/jinx
commit 5b215b3b1c7f1d97921021e762415accdf4451b2
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Initial commit
---
LICENSE | 674 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
README.org | 77 +++++++
jinx-mod.c | 153 ++++++++++++++
jinx.el | 618 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 1522 insertions(+)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000000..f288702d2f
--- /dev/null
+++ b/LICENSE
@@ -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>.
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..825e2b9534
--- /dev/null
+++ b/README.org
@@ -0,0 +1,77 @@
+#+title: Enchanted just-in-time spell checker
+#+author: Daniel Mendler
+#+language: en
+#+export_file_name: jinx.texi
+#+texinfo_dir_category: Emacs misc features
+#+texinfo_dir_title: Jinx: (jinx).
+#+texinfo_dir_desc: Enchanted just-in-time spell checker
+
+#+html: <a href="https://www.gnu.org/software/emacs/"><img alt="GNU Emacs"
src="https://github.com/minad/corfu/blob/screenshots/emacs.svg?raw=true"/></a>
+#+html: <a href="https://elpa.gnu.org/packages/jinx.html"><img alt="GNU ELPA"
src="https://elpa.gnu.org/packages/jinx.svg"/></a>
+#+html: <a href="https://elpa.gnu.org/devel/jinx.html"><img alt="GNU-devel
ELPA" src="https://elpa.gnu.org/devel/jinx.svg"/></a>
+#+html: <a href="https://melpa.org/#/jinx"><img alt="MELPA"
src="https://melpa.org/packages/jinx-badge.svg"/></a>
+#+html: <a href="https://stable.melpa.org/#/jinx"><img alt="MELPA Stable"
src="https://stable.melpa.org/packages/jinx-badge.svg"/></a>
+
+Jinx provides just-in-time spell-checking checking via
[[https://abiword.github.io/enchant/][libenchant]]. The package
+aims to achieve high performance and low resource usage, without impacting your
+editing experience. Overall Jinx should just work out of the box without much
+intervention.
+
+Jinx highlights misspellings lazily only in the visible area of the window.
Jinx
+binds directly to the native libenchant API, such that process communication
+with a backend Aspell process can be avoided. Libenchant is widely used as
+spell-checking API by text editors and supports Nuspell, Hunspell, Aspell and a
+few lesser known backends. Jinx automatically compiles and loads the native
+module at startup. Libenchant must be available for compilation. If
=pkg-config=
+is available it will be used to locate libenchant. On Debian or Ubuntu, install
+the packages =libenchant-2=, =libenchant-2-dev= and =pkg-config=.
+
+Jinx supports multiple languages in a buffer at the same time via the
+=jinx-languages= customization variable. It offers flexible settings to ignore
+misspellings via faces (=jinx-exclude-faces= and =jinx-include-faces=), regular
+expressions (=jinx-exclude-regexps=) and programmable predicates. Jinx comes
+preconfigured for the most important major modes.
+
+* Usage
+
+Jinx offers three autoloaded entry points , the modes =global-jinx-mode=,
+=jinx-mode= and the command =jinx-correct=. You can either enable
=global-jinx-mode=
+or add =jinx-mode= to the hooks of the modes.
+
+#+begin_src emacs-lisp
+ (add-hook 'emacs-startup-hook #'global-jinx-mode)
+
+ (dolist (hook '(text-mode-hook prog-mode-hook conf-mode-hook))
+ (add-hook hook #'jinx-mode))
+#+end_src
+
+In order to correct misspellings bind =jinx-correct= to a convenient key in
your
+configuration. Jinx is independent of the Ispell package, so you can reuse the
+binding =M-$= which is bound to =ispell-word= by default. When pressing =M-$=,
Jinx
+offers correction suggestions for the misspelling next to point. If the prefix
+key =C-u= is pressed, the entire buffer is spell-checked.
+
+#+begin_src emacs-lisp
+ (keymap-global-set "<remap> <ispell-word>" #'jinx-correct)
+#+end_src
+
+* Alternatives
+
+The technique to spell-check only the visible region of the window was inspired
+by Campbell Barton's spell-fu package. Spell-fu maintains the dictionary itself
+via a hash table, which results in high memory usage for languages with
compound
+words or inflected word forms. In Jinx we avoid the complexity of managing the
+dictionary and access the advanced spell-checker algorithms (affixation,
+compound words, etc.) directly via libenchant.
+
+Jinx offers a similar UI as Augusto Stoffel's jit-spell package and borrows
+ideas from it. Jit-spell uses Ispell process communication instead of a native
+API. It does not restrict the highlighting to the visible area. In my setup I
+observed an increase in load and latency as a consequence, in particular in
+combination with stealth locking and commands which trigger fontification
+eagerly like =consult-line= from my Consult package.
+
+* Contributions
+
+Since this package is part of [[https://elpa.gnu.org/packages/jinx.html][GNU
ELPA]] contributions require a copyright
+assignment to the FSF.
diff --git a/jinx-mod.c b/jinx-mod.c
new file mode 100644
index 0000000000..c275bb3de6
--- /dev/null
+++ b/jinx-mod.c
@@ -0,0 +1,153 @@
+/* Jinx bindings to libenchant
+
+Copyright (C) 2023 Free Software Foundation, Inc.
+
+GNU Emacs 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.
+
+GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
+
+#include <emacs-module.h>
+#include <enchant.h>
+#include <string.h>
+#include <glib.h>
+
+int plugin_is_GPL_compatible;
+
+static EnchantBroker* broker = 0;
+
+#define jinx_unused(var) _##var __attribute__((unused))
+
+static emacs_value jinx_str(emacs_env* env, const char* str) {
+ return env->make_string(env, str, strlen(str));
+}
+
+static emacs_value jinx_cons(emacs_env* env, emacs_value a, emacs_value b) {
+ return env->funcall(env, env->intern(env, "cons"), 2, (emacs_value[]){a,
b});
+}
+
+static char* jinx_cstr(emacs_env* env, emacs_value val) {
+ ptrdiff_t size = 0;
+ if (!env->copy_string_contents(env, val, 0, &size))
+ return 0;
+ char* str = malloc(size);
+ if (!str) {
+ env->non_local_exit_signal(env,
+ env->intern (env, "memory-full"),
+ env->intern (env, "nil"));
+ return 0;
+ }
+ if (!env->copy_string_contents(env, val, str, &size)) {
+ free(str);
+ return 0;
+ }
+ return str;
+}
+
+static void jinx_defun(emacs_env* env, const char* name,
+ ptrdiff_t min, ptrdiff_t max, void* fun) {
+ env->funcall(env, env->intern(env, "defalias"), 2,
+ (emacs_value[]){
+ env->intern(env, name),
+ env->make_function(env, min, max, fun, 0, 0)
+ });
+}
+
+static void jinx_free_dict(void* dict) {
+ enchant_broker_free_dict(broker, dict);
+}
+
+static emacs_value jinx_dict(emacs_env* env, ptrdiff_t jinx_unused(nargs),
+ emacs_value args[], void* jinx_unused(data)) {
+ if (!broker)
+ broker = enchant_broker_init();
+ g_autofree char* str = jinx_cstr(env, args[0]);
+ EnchantDict* dict = str ? enchant_broker_request_dict(broker, str) : 0;
+ return dict
+ ? env->make_user_ptr(env, jinx_free_dict, dict)
+ : env->intern(env, "nil");
+}
+
+static void jinx_describe_cb(const char* const lang_tag,
+ const char* const provider_name,
+ const char* const jinx_unused(provider_desc),
+ const char* const jinx_unused(provider_file),
+ void* data) {
+ emacs_env* env = ((emacs_env**)data)[0];
+ ((emacs_value*)data)[1] = jinx_cons(env,
+ jinx_str(env, lang_tag),
+ jinx_str(env, provider_name));
+}
+
+static emacs_value jinx_describe(emacs_env* env, ptrdiff_t jinx_unused(nargs),
+ emacs_value args[], void* jinx_unused(data)) {
+ EnchantDict* dict = env->get_user_ptr(env, args[0]);
+ if (!dict)
+ return env->intern(env, "nil");
+ void* data[] = { env, 0 };
+ enchant_dict_describe(dict, jinx_describe_cb, data);
+ return data[1];
+}
+
+static emacs_value jinx_check(emacs_env* env, ptrdiff_t jinx_unused(nargs),
+ emacs_value args[], void* jinx_unused(data)) {
+ g_autofree char* str = jinx_cstr(env, args[1]);
+ EnchantDict* dict = env->get_user_ptr(env, args[0]);
+ return env->intern(env, !str || !dict || enchant_dict_check(dict, str, -1)
+ ? "nil" : "t");
+}
+
+static emacs_value jinx_add(emacs_env* env, ptrdiff_t jinx_unused(nargs),
+ emacs_value args[], void* jinx_unused(data)) {
+ g_autofree char* str = jinx_cstr(env, args[1]);
+ EnchantDict* dict = env->get_user_ptr(env, args[0]);
+ if (str && dict)
+ enchant_dict_add(dict, str, -1);
+ return env->intern(env, "nil");
+}
+
+static emacs_value jinx_wordchars(emacs_env* env, ptrdiff_t jinx_unused(nargs),
+ emacs_value args[], void* jinx_unused(data))
{
+ EnchantDict* dict = env->get_user_ptr(env, args[0]);
+ return dict
+ ? jinx_str(env, enchant_dict_get_extra_word_characters(dict))
+ : env->intern(env, "nil");
+}
+
+static emacs_value jinx_suggest(emacs_env* env, ptrdiff_t jinx_unused(nargs),
+ emacs_value args[], void* jinx_unused(data)) {
+ g_autofree char* str = jinx_cstr(env, args[1]);
+ EnchantDict* dict = env->get_user_ptr(env, args[0]);
+ emacs_value list = env->intern(env, "nil");
+ size_t count = 0;
+ char** suggs = str && dict ? enchant_dict_suggest(dict, str, -1, &count) :
0;
+ if (suggs) {
+ while (count > 0) {
+ char* sugg = suggs[--count];
+ list = jinx_cons(env, jinx_str(env, sugg), list);
+ }
+ enchant_dict_free_string_list(dict, suggs);
+ }
+ return list;
+}
+
+int emacs_module_init(struct emacs_runtime *runtime) {
+ if (runtime->size < (ptrdiff_t)sizeof (*runtime))
+ return 1;
+ emacs_env* env = runtime->get_environment(runtime);
+ jinx_defun(env, "jinx--mod-suggest", 2, 2, jinx_suggest);
+ jinx_defun(env, "jinx--mod-check", 2, 2, jinx_check);
+ jinx_defun(env, "jinx--mod-add", 2, 2, jinx_add);
+ jinx_defun(env, "jinx--mod-dict", 1, 1, jinx_dict);
+ jinx_defun(env, "jinx--mod-describe", 1, 1, jinx_describe);
+ jinx_defun(env, "jinx--mod-wordchars", 1, 1, jinx_wordchars);
+ return 0;
+}
diff --git a/jinx.el b/jinx.el
new file mode 100644
index 0000000000..e9eaef7431
--- /dev/null
+++ b/jinx.el
@@ -0,0 +1,618 @@
+;;; jinx.el --- Enchanted just-in-time spell checker -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023 Free Software Foundation, Inc.
+
+;; Author: Daniel Mendler <mail@daniel-mendler.de>
+;; Maintainer: Daniel Mendler <mail@daniel-mendler.de>
+;; Package-Requires: ((emacs "27.1") (compat "29.1.4.0"))
+;; Created: 2023
+;; Version: 0.1
+;; Homepage: https://github.com/minad/jinx
+
+;; 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/>.
+
+;;; Commentary:
+
+;; Jinx provides just-in-time spell-checking checking via libenchant
+;; (https://abiword.github.io/enchant/). The package aims to achieve
+;; high performance and low resource usage, without impacting your
+;; editing experience. Overall Jinx should just work out of the box
+;; without much intervention.
+;;
+;; Jinx highlights misspellings lazily only in the visible area of the
+;; window. Jinx binds directly to the native libenchant API, such
+;; that process communication with a backend Aspell process can be
+;; avoided. Libenchant is widely used as spell-checking API by text
+;; editors and supports Nuspell, Hunspell, Aspell and a few lesser
+;; known backends. Jinx automatically compiles and loads the native
+;; module at startup. Libenchant must be available for compilation.
+;; If `pkg-config' is available it will be used to locate libenchant.
+;; On Debian or Ubuntu, install the packages `libenchant-2',
+;; `libenchant-2-dev' and `pkg-config'.
+;;
+;; Jinx supports multiple languages in a buffer at the same time via
+;; the `jinx-languages' customization variable. It offers flexible
+;; settings to ignore misspellings via faces (`jinx-exclude-faces' and
+;; `jinx-include-faces'), regular expressions (`jinx-exclude-regexps')
+;; and programmable predicates. Jinx comes preconfigured for the most
+;; important major modes.
+;;
+;; Jinx offers three autoloaded entry points , the modes
+;; `global-jinx-mode', `jinx-mode' and the command `jinx-correct'.
+;; You can either enable `global-jinx-mode' or add `jinx-mode' to the
+;; hooks of the modes.
+;;
+;; (add-hook 'emacs-startup-hook #'global-jinx-mode)
+;;
+;; (dolist (hook '(text-mode-hook prog-mode-hook conf-mode-hook))
+;; (add-hook hook #'jinx-mode))
+;;
+;; In order to correct misspellings bind `jinx-correct' to a
+;; convenient key in your configuration. Jinx is independent of the
+;; Ispell package, so you can reuse the binding M-$ which is bound to
+;; `ispell-word' by default. When pressing M-$, Jinx offers
+;; correction suggestions for the misspelling next to point. If the
+;; prefix key C-u is pressed, the entire buffer is spell-checked.
+;;
+;; (keymap-global-set "<remap> <ispell-word>" #'jinx-correct)
+;;
+;; The technique to spell-check only the visible region of the window
+;; was inspired by Campbell Barton's spell-fu package. Spell-fu
+;; maintains the dictionary itself via a hash table, which results in
+;; high memory usage for languages with compound words or inflected
+;; word forms. In Jinx we avoid the complexity of managing the
+;; dictionary and access the advanced spell-checker algorithms
+;; (affixation, compound words, etc.) directly via libenchant.
+;;
+;; Jinx offers a similar UI as Augusto Stoffel's jit-spell package and
+;; borrows ideas from it. Jit-spell uses Ispell process communication
+;; instead of a native API. It does not restrict the highlighting to
+;; the visible area. In my setup I observed an increase in load and
+;; latency as a consequence, in particular in combination with stealth
+;; locking and commands which trigger fontification eagerly like
+;; `consult-line' from my Consult package.
+
+;;; Code:
+
+(require 'compat)
+(eval-when-compile (require 'cl-lib))
+
+;;;; Customization
+
+(defgroup jinx nil
+ "Enchanted just-in-time spell checker."
+ :link '(info-link :tag "Info Manual" "(jinx)")
+ :link '(url-link :tag "Homepage" "https://github.com/minad/jinx")
+ :link '(emacs-library-link :tag "Library Source" "jinx.el")
+ :group 'text
+ :prefix "jinx-")
+
+(defcustom jinx-delay 0.2
+ "Idle timer delay."
+ :type 'float)
+
+(defface jinx-misspelled
+ '((((supports :underline (:style wave)))
+ :underline (:style wave :color "red"))
+ (t :underline t :inherit error))
+ "Face used for misspelled words.")
+
+(defface jinx-highlight
+ '((t :inherit isearch))
+ "Face used to highlight current misspelling during correction.")
+
+(defface jinx-accept
+ '((t :inherit font-lock-negation-char-face))
+ "Face used for the accept action during correction.")
+
+(defcustom jinx-languages "en"
+ "List of languages."
+ :type '(choice string (repeat string)))
+
+;;;###autoload
+(put 'jinx-languages 'safe-local-variable
+ (lambda (val)
+ (or (stringp val)
+ (and (listp val)
+ (catch 'break
+ (dolist (s val t)
+ (unless (stringp s)
+ (throw 'break nil))))))))
+
+(defcustom jinx-include-faces
+ '((prog-mode font-lock-comment-face
+ font-lock-doc-face
+ font-lock-string-face)
+ (conf-mode font-lock-comment-face
+ font-lock-string-face))
+ "Alist of faces per major mode.
+These faces mark regions which should be included in spell
+checking."
+ :type '(alist :key-type symbol :value-type (repeat face)))
+
+(defcustom jinx-exclude-faces
+ '((markdown-mode
+ markdown-code-face markdown-html-attr-name-face
+ markdown-html-attr-value-face markdown-html-tag-name-face
+ markdown-inline-code-face markdown-link-face
+ markdown-markup-face markdown-plain-url-face
+ markdown-reference-face markdown-url-face)
+ (org-mode
+ org-block org-block-begin-line org-block-end-line
+ org-code org-cite org-cite-key org-date org-footnote
+ org-formula org-latex-and-related org-link org-meta-line
+ org-property-value org-ref-cite-face org-special-keyword
+ org-tag org-todo org-todo-keyword-done
+ org-todo-keyword-habt org-todo-keyword-kill
+ org-todo-keyword-outd org-todo-keyword-todo
+ org-todo-keyword-wait org-verbatim
+ org-modern-tag org-modern-date-active org-modern-date-inactive)
+ (tex-mode
+ font-latex-math-face font-latex-sedate-face
+ font-lock-function-name-face font-lock-keyword-face
+ font-lock-variable-name-face)
+ (texinfo-mode
+ font-lock-function-name-face font-lock-keyword-face
+ font-lock-variable-name-face)
+ (rst-mode
+ rst-literal rst-external rst-directive rst-definition
+ rst-reference)
+ (sgml-mode
+ font-lock-function-name-face font-lock-variable-name-face)
+ (emacs-lisp-mode
+ font-lock-constant-face font-lock-warning-face))
+ "Alist of faces per major mode.
+These faces mark regions which should be excluded in spell
+checking."
+ :type '(alist :key-type symbol :value-type (repeat face)))
+
+(defcustom jinx-exclude-regexps
+ '((emacs-lisp-mode "Package-Requires:.*$")
+ (t "[A-Z]+\\>" ;; Uppercase words
+ "\\w*?[0-9]\\w*\\>" ;; Words with numbers, hex codes
+ "[a-z]+://\\w*\\>" ;; URI
+ "<?[-+_.~a-zA-Z][-+_.~:a-zA-Z0-9]*@[-.a-zA-Z0-9]+>?")) ;; Email
+ "List of excluded regexps."
+ :type '(alist :key-type symbol :value-type (repeat regexp)))
+
+(defcustom jinx-include-modes
+ '(text-mode prog-mode conf-mode)
+ "List of modes included by `global-jinx-mode'."
+ :type '(repeat symbol))
+
+;;;; Internal variables
+
+(defvar jinx--predicates
+ (list #'jinx--face-ignored-p
+ #'jinx--regexp-ignored-p
+ #'jinx--word-valid-p
+ #'jinx--flyspell-ignored-p)
+ "Predicate functions called at point with argument START.
+Predicate should return t if the word before point is valid.
+Predicate may return a position to skip forward.")
+
+(defvar jinx--timer nil
+ "Global timer to check pending regions.")
+
+(defvar-local jinx--exclude-faces nil
+ "List of excluded faces.")
+
+(defvar-local jinx--include-faces nil
+ "List of included faces.")
+
+(defvar-local jinx--exclude-regexp nil
+ "Ignore regexp.")
+
+(defvar-local jinx--dicts nil
+ "List of dictionaries.")
+
+(defvar-local jinx--syntax-table nil
+ "Syntax table used during checking.")
+
+(defvar-local jinx--mode-syntax-table nil
+ "Original syntax table of the mode.")
+
+(defvar-local jinx--session-words nil
+ "List of words accepted in this session.")
+
+;;;; Declarations for the bytecode compiler
+
+(defvar jinx-mode)
+(declare-function jinx--mod-check nil)
+(declare-function jinx--mod-add nil)
+(declare-function jinx--mod-suggest nil)
+(declare-function jinx--mod-dict nil)
+(declare-function jinx--mod-describe nil)
+(declare-function jinx--mod-wordchars nil)
+
+;;;; Overlay properties
+
+(put 'jinx 'evaporate t)
+(put 'jinx 'face 'jinx-misspelled)
+(put 'jinx 'modification-hooks (list #'jinx--overlay-modified))
+(put 'jinx 'insert-in-front-hooks (list #'jinx--overlay-modified))
+(put 'jinx 'insert-behind-hooks (list #'jinx--overlay-modified))
+
+;;;; Predicates
+
+(defun jinx--regexp-ignored-p (start)
+ "Return non-nil if word at START matches ignore regexps."
+ (save-excursion
+ (let (case-fold-search)
+ (goto-char start)
+ (when (and jinx--exclude-regexp (looking-at-p jinx--exclude-regexp))
+ (save-match-data
+ (looking-at jinx--exclude-regexp)
+ (match-end 0))))))
+
+(defun jinx--face-ignored-p (start)
+ "Return non-nil if face at START of word is ignored."
+ (let ((face (get-text-property start 'face)))
+ (or
+ (and jinx--include-faces
+ (if (listp face)
+ (cl-loop for f in face never (memq f jinx--include-faces))
+ (not (memq face jinx--include-faces))))
+ (and jinx--exclude-faces
+ (if (listp face)
+ (cl-loop for f in face thereis (memq f jinx--exclude-faces))
+ (memq face jinx--exclude-faces))))))
+
+(defun jinx--word-valid-p (start)
+ "Return non-nil if word at START is valid."
+ (let ((word (buffer-substring-no-properties start (point))))
+ (or (member word jinx--session-words)
+ (cl-loop for dict in jinx--dicts
+ thereis (jinx--mod-check dict word)))))
+
+(defun jinx--flyspell-ignored-p (_start)
+ "Check if word before point is ignored.
+This predicate uses the `flyspell-mode-predicate' provided by
+some Emacs modes."
+ (when-let ((pred (or (bound-and-true-p flyspell-generic-check-word-predicate)
+ (get major-mode 'flyspell-mode-predicate))))
+ (with-syntax-table jinx--mode-syntax-table
+ (ignore-errors (not (funcall pred))))))
+
+;;;; Internal functions
+
+(defun jinx--overlay-modified (overlay &rest _)
+ "Delete modified OVERLAY.
+This function is a modification hook for the overlay."
+ (delete-overlay overlay))
+
+(defun jinx--check-pending (start end)
+ "Check pending regions between START and END."
+ (while-let ((from (text-property-any start end 'jinx--pending t))
+ (to (or (text-property-any from end 'jinx--pending nil) end)))
+ (jinx--check-region from to)
+ (setq start to)))
+
+(defun jinx--check-region (start end)
+ "Check region between START and END."
+ (let ((jinx--mode-syntax-table (syntax-table)))
+ (unwind-protect
+ (with-silent-modifications
+ (save-excursion
+ (save-match-data
+ (set-syntax-table jinx--syntax-table)
+ (jinx--delete-overlays start end)
+ (goto-char start)
+ (while (re-search-forward "\\<\\w+\\>" end t)
+ (let ((word-start (match-beginning 0))
+ (word-end (point)))
+ ;; No quote or apostrophe at end
+ (while (and (< word-start word-end)
+ (let ((c (char-before word-end))) (or (= c 39)
(= c 8217))))
+ (cl-decf word-end))
+ (when (< word-start word-end)
+ (goto-char word-end)
+ (pcase (run-hook-with-args-until-success 'jinx--predicates
word-start)
+ ((and (pred integerp) skip) (goto-char (max word-end
(min end skip))))
+ ('nil (overlay-put (make-overlay word-start word-end)
'category 'jinx))))))
+ (remove-list-of-text-properties start end '(jinx--pending)))
+ (set-syntax-table jinx--mode-syntax-table))))))
+
+(defun jinx--get-overlays (start end)
+ "Return misspelled words overlays between START and END."
+ (cl-loop for ov in (overlays-in start end)
+ if (eq (overlay-get ov 'category) 'jinx) collect ov))
+
+(defun jinx--delete-overlays (start end)
+ "Delete overlays between START and END."
+ (dolist (ov (overlays-in start end))
+ (when (eq 'jinx (overlay-get ov 'category))
+ (delete-overlay ov))))
+
+(defun jinx--cleanup ()
+ "Cleanup all overlays and trigger fontification."
+ (with-silent-modifications
+ (save-restriction
+ (widen)
+ (jinx--delete-overlays (point-min) (point-max))
+ (remove-list-of-text-properties (point-min) (point-max) '(jinx--pending))
+ (jit-lock-refontify))))
+
+(defun jinx--mark-pending (start end)
+ "Mark region between START and END as pending."
+ (save-excursion
+ (goto-char start)
+ (re-search-backward "[[:blank:]]\\|^")
+ (setq start (match-end 0))
+ (goto-char end)
+ (re-search-forward "[[:blank:]]\\|$")
+ (setq end (match-beginning 0))
+ (put-text-property start end 'jinx--pending t)
+ ;; inhibit-quit is non-nil for stealth locking
+ (unless inhibit-quit (jinx--schedule))
+ `(jit-lock-bounds ,start . ,end)))
+
+(defun jinx--mode-list (list)
+ "Lookup by major mode in LIST."
+ (cl-loop for (mode . vals) in list
+ if (or (eq mode t) (derived-mode-p mode)) append vals))
+
+(defun jinx--get-org-language ()
+ "Get language from Org #+language keyword."
+ (when (and (not (local-variable-p 'jinx-languages))
+ (derived-mode-p 'org-mode))
+ (save-excursion
+ (save-match-data
+ (goto-char (point-min))
+ (when (re-search-forward "^ *#\\+language: +\\([a-z_]+\\) *$" nil t)
+ (setq-local jinx-languages (match-string-no-properties 1)))))))
+
+(defun jinx--timer-handler ()
+ "Global timer handler, checking the pending regions in all windows."
+ (setq jinx--timer nil)
+ (dolist (frame (frame-list))
+ (dolist (win (window-list frame 'no-miniwindow))
+ (with-current-buffer (window-buffer win)
+ (when jinx-mode
+ (jinx--check-pending (window-start win) (window-end win)))))))
+
+(defun jinx--reschedule (&rest _)
+ "Restart the global idle timer."
+ (when jinx--timer
+ (cancel-timer jinx--timer)
+ (setq jinx--timer nil))
+ (jinx--schedule))
+
+(defun jinx--schedule ()
+ "Start the global idle timer."
+ (when (and (not jinx--timer) (get-buffer-window))
+ (setq jinx--timer
+ (run-with-idle-timer jinx-delay
+ nil #'jinx--timer-handler))))
+
+(defun jinx--load-module ()
+ "Compile and load native module."
+ (unless (fboundp #'jinx--mod-dict)
+ (unless module-file-suffix
+ (error "Jinx: Native modules are not supported"))
+ (let ((default-directory
+ (file-name-directory (locate-library "jinx.el" t)))
+ (module (concat "jinx-mod" module-file-suffix)))
+ (unless (file-exists-p module)
+ (let ((command
+ `("cc" "-O2" "-Wall" "-Wextra" "-fPIC" "-shared"
"-Wl,--no-as-needed"
+ ,@(split-string-and-unquote
+ (condition-case nil
+ (car (process-lines "pkg-config" "--cflags" "--libs"
"enchant-2"))
+ (error "-I/usr/include/glib-2.0 -I/usr/include/enchant-2
-lenchant-2")))
+ ,@(and source-directory
+ (list (concat "-I" (file-name-concat source-directory
"src/"))))
+ "-o" ,module ,(file-name-with-extension module ".c"))))
+ (with-current-buffer (get-buffer-create "*jinx module compilation*")
+ (let ((inhibit-read-only t))
+ (erase-buffer)
+ (insert (string-join command " ") "\n")
+ (if (equal 0 (apply #'call-process (car command) nil
(current-buffer) t (cdr command)))
+ (message "Jinx: %s compiled successfully" module)
+ (compilation-mode)
+ (pop-to-buffer (current-buffer))
+ (error "Jinx: Compilation of %s failed" module))))))
+ (module-load (expand-file-name module)))))
+
+(defun jinx--force-check (start end)
+ "Enforce spell-check of region between START and END.
+Return list of overlays, see `jinx--get-overlays'."
+ (or
+ (jinx--get-overlays start end)
+ (let (message-log-max)
+ (message "Fontifying...")
+ (jit-lock-fontify-now)
+ (message "Checking...")
+ (jinx--check-region start end)
+ (message "Done")
+ (jinx--get-overlays start end))
+ (error "No misspelled word found")))
+
+(defun jinx--annotate-suggestion (word)
+ "Annotate WORD during completion."
+ (get-text-property 0 'jinx--annotation word))
+
+(defun jinx--group-suggestion (word transform)
+ "Group WORD during completion, TRANSFORM candidate if non-nil."
+ (if transform
+ word
+ (get-text-property 0 'jinx--group word)))
+
+(defun jinx--suggestions (word)
+ "Retrieve suggestions for WORD."
+ (delete-dups
+ (nconc
+ (cl-loop
+ for dict in jinx--dicts nconc
+ (let* ((suggs (jinx--mod-suggest dict word))
+ (desc (jinx--mod-describe dict))
+ (group (format "Suggestions from dictionary ‘%s’ (%s)"
+ (car desc) (cdr desc))))
+ (dolist (sugg suggs suggs)
+ (put-text-property 0 (length sugg) 'jinx--group group sugg))))
+ (cl-loop
+ for dict in jinx--dicts for idx from 1 nconc
+ (let* ((at (propertize (make-string idx ?@)
+ 'face 'jinx-accept
+ 'rear-nonsticky t))
+ (desc (jinx--mod-describe dict))
+ (group "Accept and save word")
+ (ann (format " [Personal dictionary ‘%s’]" (car desc))))
+ (list (propertize (concat at word)
+ 'jinx--group group 'jinx--annotation ann)
+ (propertize (concat at (downcase word))
+ 'jinx--group group 'jinx--annotation ann))))
+ (list
+ (propertize (concat #("#" 0 1 (face jinx-accept rear-nonsticky t)) word)
+ 'jinx--group "Accept and save word"
+ 'jinx--annotation " [Session]")))))
+
+(defun jinx--suggestion-table (word)
+ "Completion table for WORD suggestions."
+ (setq word (jinx--suggestions word))
+ (lambda (str pred action)
+ (if (eq action 'metadata)
+ '(metadata (display-sort-function . identity)
+ (cycle-sort-function . identity)
+ (category . jinx)
+ (group-function . jinx--group-suggestion)
+ (annotation-function . jinx--annotate-suggestion))
+ (complete-with-action action word str pred))))
+
+(defun jinx--correct (overlay &optional recenter)
+ "Correct word at OVERLAY, optionally RECENTER."
+ (let* ((start (overlay-start overlay))
+ (end (goto-char (overlay-end overlay)))
+ (word (buffer-substring-no-properties start end))
+ (hl nil)
+ (selected
+ (unwind-protect
+ (progn
+ (when recenter (recenter))
+ (setq hl (make-overlay start end))
+ (overlay-put hl 'face 'jinx-highlight)
+ (overlay-put hl 'window (selected-window))
+ (or (completing-read
+ (format "Correct ‘%s’ (RET to skip): " word)
+ (jinx--suggestion-table word)
+ nil nil nil t word)
+ word))
+ (delete-overlay hl))))
+ (if (string-match-p "\\`[@#]" selected)
+ (let* ((new-word (replace-regexp-in-string "\\`[@#]+" "" selected))
+ (idx (- (length selected) (length new-word) 1)))
+ (when (equal new-word "") (setq new-word word))
+ (if (string-prefix-p "#" selected)
+ (unless (member new-word jinx--session-words)
+ (push new-word jinx--session-words))
+ (jinx--mod-add (or (nth idx jinx--dicts)
+ (user-error "Invalid dictionary"))
+ new-word))
+ (save-restriction
+ (widen)
+ (dolist (overlay (jinx--get-overlays (point-min) (point-max)))
+ (goto-char (overlay-end overlay))
+ (when (jinx--word-valid-p (overlay-start overlay))
+ (delete-overlay overlay)))))
+ (unless (equal selected word)
+ (delete-overlay overlay)
+ (insert-before-markers selected)
+ (delete-region start end)))))
+
+(defun jinx--nearest-overlay ()
+ "Find nearest misspelled word."
+ (let* ((overlays (jinx--force-check (window-start) (window-end)))
+ (nearest (car overlays)))
+ (dolist (ov (cdr overlays) nearest)
+ (when (< (abs (- (overlay-start ov) (point)))
+ (abs (- (overlay-start nearest) (point))))
+ (setq nearest ov)))))
+
+;;;; Public commands
+
+;;;###autoload
+(defun jinx-correct (&optional all)
+ "Correct nearest misspelled word.
+If predicate argument ALL is given correct all misspellings."
+ (interactive "*P")
+ (unless jinx-mode (jinx-mode 1))
+ (unwind-protect
+ (save-window-excursion
+ (save-excursion
+ (cl-letf (((symbol-function #'jinx--timer-handler) #'ignore)) ;;
Inhibit
+ (if all
+ (dolist (overlay
+ (sort (jinx--force-check (point-min) (point-max))
+ (lambda (a b) (< (overlay-start a)
(overlay-start b)))))
+ (when (overlay-buffer overlay) ;; Could be already deleted
+ (jinx--correct overlay 'recenter)))
+ (jinx--correct (jinx--nearest-overlay))))))
+ (jit-lock-refontify)))
+
+;;;###autoload
+(define-minor-mode jinx-mode
+ "Enchanted just-in-time spell checker."
+ :global nil :group 'jinx
+ (cond
+ (jinx-mode
+ (jinx--load-module)
+ (hack-local-variables)
+ (jinx--get-org-language)
+ (setq jinx--exclude-regexp
+ (when-let ((regexps (jinx--mode-list jinx-exclude-regexps)))
+ (mapconcat (lambda (r) (format "\\(?:%s\\)" r))
+ regexps "\\|"))
+ jinx--include-faces (jinx--mode-list jinx-include-faces)
+ jinx--exclude-faces (jinx--mode-list jinx-exclude-faces)
+ jinx--dicts (delq nil (mapcar #'jinx--mod-dict
+ (ensure-list jinx-languages)))
+ jinx--syntax-table (make-syntax-table))
+ (unless jinx--dicts
+ (message "Jinx: No dictionaries available for `jinx-languages' = %S"
+ jinx-languages))
+ (modify-syntax-entry ?' "w" jinx--syntax-table)
+ (modify-syntax-entry ?$ "_" jinx--syntax-table)
+ (modify-syntax-entry ?% "_" jinx--syntax-table)
+ (dolist (dict jinx--dicts)
+ (cl-loop for c across (jinx--mod-wordchars dict) do
+ (modify-syntax-entry c "w" jinx--syntax-table)))
+ (add-hook 'window-state-change-hook #'jinx--reschedule nil t)
+ (add-hook 'window-scroll-functions #'jinx--reschedule nil t)
+ (add-hook 'post-command-hook #'jinx--reschedule nil t)
+ (jit-lock-register #'jinx--mark-pending))
+ (t
+ (kill-local-variable 'jinx--exclude-regexp)
+ (kill-local-variable 'jinx--include-faces)
+ (kill-local-variable 'jinx--exclude-faces)
+ (kill-local-variable 'jinx--dicts)
+ (kill-local-variable 'jinx--syntax-table)
+ (remove-hook 'window-state-change-hook #'jinx--reschedule t)
+ (remove-hook 'window-scroll-functions #'jinx--reschedule t)
+ (remove-hook 'post-command-hook #'jinx--reschedule t)
+ (jit-lock-unregister #'jinx--mark-pending)
+ (jinx--cleanup))))
+
+;;;###autoload
+(define-globalized-minor-mode global-jinx-mode jinx-mode jinx--on :group 'jinx)
+
+(defun jinx--on ()
+ "Turn `jinx-mode' on."
+ (when (and (not (or noninteractive
+ buffer-read-only
+ (eq (aref (buffer-name) 0) ?\s)))
+ (seq-some #'derived-mode-p jinx-include-modes))
+ (jinx-mode 1)))
+
+(provide 'jinx)
+;;; jinx.el ends here