branch: master
commit b35b6eb5a939736c9c2c678627c3dfc72bc2f95a
Author: Ian Dunn <du...@gnu.org>
Commit: Ian Dunn <du...@gnu.org>
Initial import
---
COPYING | 674 ++++++++++++++++++++++++++++++++++++++++
Project.ede | 47 +++
bootstrap.sh | 24 ++
paced-async.el | 94 ++++++
paced-tests.el | 366 ++++++++++++++++++++++
paced.el | 844 ++++++++++++++++++++++++++++++++++++++++++++++++++
paced.org | 169 ++++++++++
test-files/first.txt | 1 +
test-files/second.cpp | 1 +
test-files/third.org | 1 +
test.mk | 27 ++
11 files changed, 2248 insertions(+)
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..94a9ed0
--- /dev/null
+++ b/COPYING
@@ -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.
+
+ <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 <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>.
diff --git a/Project.ede b/Project.ede
new file mode 100644
index 0000000..78cd3d8
--- /dev/null
+++ b/Project.ede
@@ -0,0 +1,47 @@
+;; Object ede-proj-project
+
+;; Copyright (c) 2017 Ian Dunn
+
+;; This file is NOT part of GNU Emacs.
+
+;; 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/>.
+
+;; EDE Project Files are auto generated: Do Not Edit
+
+(ede-proj-project "ede-proj-project"
+ :file "Project.ede"
+ :name "paced"
+ :targets
+ (list
+ (ede-proj-target-elisp "ede-proj-target-elisp"
+ :name "compile"
+ :path ""
+ :source '("paced.el" "paced-async.el")
+ :aux-packages '("async" "paced"))
+ (ede-proj-target-elisp-autoloads "ede-proj-target-elisp-autoloads"
+ :name "autoloads"
+ :path ""
+ :source '("paced.el" "paced-async.el")
+ :autoload-file "paced-autoloads.el")
+ (ede-proj-target-makefile-miscelaneous
"ede-proj-target-makefile-miscelaneous"
+ :name "check"
+ :path ""
+ :source '("paced-tests.el" "test.mk" "test-files/first.txt"
"test-files/second.cpp" "test-files/third.org")
+ :partofall nil
+ :submakefile "test.mk")
+ (ede-proj-target-aux "ede-proj-target-aux"
+ :name "extra"
+ :path ""
+ :source '("paced.org")))
+ :configuration-variables nil)
diff --git a/bootstrap.sh b/bootstrap.sh
new file mode 100755
index 0000000..768dec0
--- /dev/null
+++ b/bootstrap.sh
@@ -0,0 +1,24 @@
+#! /bin/bash
+
+# Copyright (C) 2017 Ian Dunn
+
+# 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/>.
+
+emacs \
+ --batch \
+ -l ede/proj -l ede/proj-elisp -l ede/proj-misc \
+ --eval "(progn (global-ede-mode) \
+ (setq ede-project-directories t) \
+ (find-file \"Project.ede\") \
+ (ede-proj-regenerate))"
diff --git a/paced-async.el b/paced-async.el
new file mode 100644
index 0000000..f324c35
--- /dev/null
+++ b/paced-async.el
@@ -0,0 +1,94 @@
+;;; paced-async.el --- Support for asynchronous population -*-
lexical-binding: t; -*-
+
+;; Copyright (c) 2017 Ian Dunn
+
+;; Author: Ian Dunn <du...@gnu.org>
+;; Version: 1.0
+
+;; This file is NOT part of GNU Emacs.
+
+;; 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, 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/>.
+
+;;; Commentary:
+
+;; Population can be a slow task. The more files from which you want to
+;; populate a dictionary, the longer repopulation is going to take.
+
+;; This extension to paced takes advantage of John Wiegley's async package to
+;; repopulate a dictionary asynchronously.
+
+;;; Code:
+
+(require 'paced)
+(require 'async)
+
+(defcustom paced-async-load-file (locate-user-emacs-file "paced-async.el")
+ "File to load with user-specific population settings.
+
+This may contain commands required for running each dictionary's
+population commmands, or load additional files."
+ :group 'paced
+ :type 'file)
+
+(cl-defmethod paced-repopulate-dictionary-async ((dictionary paced-dictionary))
+ "Repopulate DICTIONARY asynchronously.
+
+Note that DICTIONARY isn't modified directly by this process, but
+the updated dictionary is loaded when repopulation completes.
+Therefore, you can continue using it without issue during
+repopulation.
+
+Side note: All dictionaries are reloaded when this function
+finishes, so temporary changes to any dictionaries will be lost
+as a result."
+ (let* ((variables '("load-path" ;; Find libraries, including paced
+ ;; Settings
+ "paced-thing-at-point-constituent"
+ "paced-dictionary-directory"
+ ;; The load file itself
+ "paced-async-load-file"))
+ (inject-string (concat "^\\("
+ (mapconcat 'identity variables "\\|")
+ "\\)$")))
+ (message "Repopulating dictionary %s" (paced-dictionary-name dictionary))
+ (async-start
+ `(lambda ()
+ ;; Inject the environment to get `load-path' and user settings
+ ,(async-inject-variables inject-string)
+ ;; Require paced and load the async settings file
+ (require 'paced)
+ (load-file paced-async-load-file)
+ ;; Repopulate and save the dictionary
+ (paced-repopulate-dictionary ,dictionary)
+ (paced-save-dictionary ,dictionary))
+ (lambda (_result)
+ (message "Finished repopulating dictionary")
+ (paced-load-all-dictionaries)))))
+
+(defun paced-repopulate-named-dictionary-async (key)
+ "Repopulate dictionary named KEY from its population commands,
asynchronously.
+
+Population commands are stored in the field of the same name.
+
+Note that this will empty the dictionary's contents.
+
+If UPDATE-IN-ALL-BUFFERS is non-nil, update the dictionary in all buffers in
which it's used."
+ (interactive
+ (list (paced-read-dictionary)))
+ (paced-ensure-registered key)
+ (let ((dict (paced-named-dictionary key)))
+ (paced-repopulate-dictionary-async dict)))
+
+(provide 'paced-async)
+
+;;; paced-async.el ends here
diff --git a/paced-tests.el b/paced-tests.el
new file mode 100644
index 0000000..c05a52c
--- /dev/null
+++ b/paced-tests.el
@@ -0,0 +1,366 @@
+;;; paced-tests.el --- Tests for paced -*- lexical-binding: t; -*-
+
+;; Copyright (c) 2017 Ian Dunn
+
+;; Author: Ian Dunn <du...@gnu.org>
+;; Version: 1.0
+
+;; This file is NOT part of GNU Emacs.
+
+;; 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, 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/>.
+
+;;; Commentary:
+
+;;; Code:
+
+(require 'paced)
+(require 'ert)
+
+(defconst paced-test-dir
+ (expand-file-name "test-files" (file-name-directory (or load-file-name
buffer-file-name))))
+
+(defsubst paced-test-file (base-name)
+ (expand-file-name base-name paced-test-dir))
+
+(defconst paced-first-test-file (paced-test-file "first.txt"))
+(defconst paced-second-test-file (paced-test-file "second.cpp"))
+(defconst paced-third-test-file (paced-test-file "third.org"))
+
+(defconst paced-test-dict-save-file (paced-test-file
"paced-dictionary-case-sensitive"))
+
+(ert-deftest paced-create-dictionary ()
+ (let* ((paced--registered-dictionaries nil)
+ (target-file-exists (file-exists-p paced-test-dict-save-file))
+ (old-mod-time (and target-file-exists
+ (file-attribute-modification-time (file-attributes
paced-test-dict-save-file))))
+ (new-dict (paced-make-dictionary 'test-dict-case
+ paced-test-dict-save-file
+ t)))
+ (should (= (length paced--registered-dictionaries) 1))
+ (should (paced-dictionary-p new-dict))
+ (oset new-dict updated t) ;; Mark it as updated so it saves
+ (paced-save-dictionary new-dict)
+ (should (file-exists-p paced-test-dict-save-file))
+ ;; Either it didn't exist before, or the old mod time is before the new mod
+ ;; time. In other words, it updated.
+ (should (or (not target-file-exists)
+ (time-less-p old-mod-time
+ (file-attribute-modification-time
(file-attributes paced-test-dict-save-file)))))))
+
+(ert-deftest paced-load-dictionary ()
+ (let* ((paced--registered-dictionaries nil))
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (should (= (length paced--registered-dictionaries) 1))
+ (should (map-contains-key paced--registered-dictionaries 'test-dict-case))
+ (should (paced-dictionary-p (map-elt paced--registered-dictionaries
'test-dict-case)))))
+
+(defvar paced-test-enable-symbol nil)
+
+(ert-deftest paced-enable-list-symbol ()
+ "Test case for `paced-dictionary-enable-alist' being an arbitrary symbol."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((paced-test-enable-symbol .
test-dict-case)))
+ (new-buffer (find-file-noselect paced-first-test-file)))
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (with-current-buffer new-buffer
+ (setq paced-test-enable-symbol nil)
+ (should-not (paced-current-dictionary))
+ (setq-local paced-test-enable-symbol t)
+ (should (paced-dictionary-p (paced-current-dictionary)))
+ (should (eq (paced-dictionary-name (paced-current-dictionary))
'test-dict-case)))
+ (kill-buffer new-buffer)))
+
+(ert-deftest paced-enable-list-mode ()
+ "Test case for `paced-dictionary-enable-alist' being a mode symbol."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((text-mode . test-dict-case)))
+ (buffer-one (find-file-noselect paced-first-test-file))
+ (buffer-two (find-file-noselect paced-second-test-file)))
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (with-current-buffer buffer-two
+ (should-not (paced-current-dictionary)))
+ (kill-buffer buffer-two)
+ (with-current-buffer buffer-one
+ (should (paced-dictionary-p (paced-current-dictionary)))
+ (should (eq (paced-dictionary-name (paced-current-dictionary))
'test-dict-case)))
+ (kill-buffer buffer-one)))
+
+(defun paced-test-function-symbol ()
+ paced-test-enable-symbol)
+
+(ert-deftest paced-enable-list-function-symbol ()
+ "Test case for `paced-dictionary-enable-alist' being a function symbol."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((paced-test-function-symbol .
test-dict-case)))
+ (buffer-one (find-file-noselect paced-first-test-file)))
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (with-current-buffer buffer-one
+ (setq-local paced-test-enable-symbol nil)
+ (should-not (paced-current-dictionary))
+ (setq-local paced-test-enable-symbol t)
+ (should (paced-dictionary-p (paced-current-dictionary)))
+ (should (eq (paced-dictionary-name (paced-current-dictionary))
'test-dict-case)))
+ (kill-buffer buffer-one)))
+
+(ert-deftest paced-enable-list-lambda-function ()
+ "Test case for `paced-dictionary-enable-alist' being a lambda form."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '(((lambda nil
paced-test-enable-symbol) . test-dict-case)))
+ (buffer-one (find-file-noselect paced-first-test-file)))
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (with-current-buffer buffer-one
+ (setq-local paced-test-enable-symbol nil)
+ (should-not (paced-current-dictionary))
+ (setq-local paced-test-enable-symbol t)
+ (should (paced-dictionary-p (paced-current-dictionary)))
+ (should (eq (paced-dictionary-name (paced-current-dictionary))
'test-dict-case)))
+ (kill-buffer buffer-one)))
+
+(ert-deftest paced-enable-list-and-form ()
+ "Test case for `paced-dictionary-enable-alist' being an 'and' form."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '(((and text-mode
paced-test-enable-symbol) . test-dict-case)))
+ (buffer-one (find-file-noselect paced-first-test-file))
+ (buffer-two (find-file-noselect paced-second-test-file)))
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (with-current-buffer buffer-two
+ (setq-local paced-test-enable-symbol nil)
+ (should-not (paced-current-dictionary))
+ (setq-local paced-test-enable-symbol t)
+ (should-not (paced-current-dictionary)))
+ (kill-buffer buffer-two)
+ (with-current-buffer buffer-one
+ (setq-local paced-test-enable-symbol nil)
+ (should-not (paced-current-dictionary))
+ (setq-local paced-test-enable-symbol t)
+ (should (paced-dictionary-p (paced-current-dictionary)))
+ (should (eq (paced-dictionary-name (paced-current-dictionary))
'test-dict-case)))
+ (kill-buffer buffer-one)))
+
+(ert-deftest paced-enable-list-or-form ()
+ "Test case for `paced-dictionary-enable-alist' being an 'or' form."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '(((or text-mode
paced-test-enable-symbol) . test-dict-case)))
+ (buffer-one (find-file-noselect paced-first-test-file))
+ (buffer-two (find-file-noselect paced-second-test-file)))
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (with-current-buffer buffer-two
+ (setq-local paced-test-enable-symbol nil)
+ (should-not (paced-current-dictionary))
+ (setq-local paced-test-enable-symbol t)
+ (should (paced-dictionary-p (paced-current-dictionary)))
+ (should (eq (paced-dictionary-name (paced-current-dictionary))
'test-dict-case)))
+ (kill-buffer buffer-two)
+ (with-current-buffer buffer-one
+ (setq-local paced-test-enable-symbol nil)
+ (should (paced-dictionary-p (paced-current-dictionary)))
+ (should (eq (paced-dictionary-name (paced-current-dictionary))
'test-dict-case))
+ (setq-local paced-test-enable-symbol t)
+ (should (paced-dictionary-p (paced-current-dictionary)))
+ (should (eq (paced-dictionary-name (paced-current-dictionary))
'test-dict-case)))
+ (kill-buffer buffer-one)))
+
+(ert-deftest paced-populate-file ()
+ "Test case for single file populator."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((text-mode . test-dict-case)))
+ (cmd (paced-file-population-command :file paced-first-test-file))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (eq (map-length usage-hash) 4))
+ (should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three"
"four")))
+ (should (eq (map-elt usage-hash "one") 1))
+ (should (eq (map-elt usage-hash "two") 2))
+ (should (eq (map-elt usage-hash "three") 3))
+ (should (eq (map-elt usage-hash "four") 4)))))
+
+(ert-deftest paced-populate-buffer ()
+ "Test case for single buffer populator."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((text-mode . test-dict-case)))
+ (buffer "first.txt")
+ (buffer-one (find-file-noselect paced-first-test-file))
+ (cmd (paced-buffer-population-command :buffer buffer))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (eq (map-length usage-hash) 4))
+ (should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three"
"four")))
+ (should (eq (map-elt usage-hash "one") 1))
+ (should (eq (map-elt usage-hash "two") 2))
+ (should (eq (map-elt usage-hash "three") 3))
+ (should (eq (map-elt usage-hash "four") 4)))
+ (kill-buffer buffer-one)))
+
+(ert-deftest paced-populate-file-function ()
+ "Test case for file-function populator."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((text-mode . test-dict-case)))
+ (pre-func (lambda () (insert (buffer-string)) t))
+ (cmd (paced-file-function-population-command :file
paced-first-test-file
+ :setup-func pre-func))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (eq (map-length usage-hash) 4))
+ (should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three"
"four")))
+ (should (eq (map-elt usage-hash "one") 2))
+ (should (eq (map-elt usage-hash "two") 4))
+ (should (eq (map-elt usage-hash "three") 6))
+ (should (eq (map-elt usage-hash "four") 8)))))
+
+(ert-deftest paced-populate-directory-regexp ()
+ "Test case for directory-regexp populator."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((text-mode . test-dict-case)))
+ (cmd (paced-directory-regexp-population-command :directory
paced-test-dir
+ :regexp ".*\\.txt"
+ :recursive t))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (eq (map-length usage-hash) 4))
+ (should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three"
"four")))
+ (should (eq (map-elt usage-hash "one") 1))
+ (should (eq (map-elt usage-hash "two") 2))
+ (should (eq (map-elt usage-hash "three") 3))
+ (should (eq (map-elt usage-hash "four") 4)))))
+
+(ert-deftest paced-populate-file-list ()
+ "Test case for file-list populator."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((text-mode . test-dict-case)))
+ (file-list (lambda () `(,paced-first-test-file)))
+ (cmd (paced-file-list-population-command :generator file-list))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (eq (map-length usage-hash) 4))
+ (should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three"
"four")))
+ (should (eq (map-elt usage-hash "one") 1))
+ (should (eq (map-elt usage-hash "two") 2))
+ (should (eq (map-elt usage-hash "three") 3))
+ (should (eq (map-elt usage-hash "four") 4)))))
+
+(ert-deftest paced-multiple-population-commands ()
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((text-mode . test-dict-case)))
+ (cmd1 (paced-file-population-command :file paced-first-test-file))
+ (cmd2 (paced-file-population-command :file paced-third-test-file))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd1 cmd2))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (eq (map-length usage-hash) 7))
+ (should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three"
"four" "five" "six" "seven")))
+ (should (eq (map-elt usage-hash "one") 1))
+ (should (eq (map-elt usage-hash "two") 2))
+ (should (eq (map-elt usage-hash "three") 3))
+ (should (eq (map-elt usage-hash "four") 4))
+ (should (eq (map-elt usage-hash "five") 5))
+ (should (eq (map-elt usage-hash "six") 3))
+ (should (eq (map-elt usage-hash "seven") 1)))))
+
+(ert-deftest paced-populator-settings ()
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((text-mode . test-dict-case)))
+ (exclude-command (lambda nil (nth 8 (syntax-ppss)))) ;; exclude
comments
+ (cmd1 (paced-file-population-command :file paced-first-test-file))
+ (cmd2 (paced-file-population-command :file paced-second-test-file
+ :props `((paced-exclude-function
quote ,exclude-command))))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd1 cmd2))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (eq (map-length usage-hash) 4))
+ (should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three"
"four")))
+ (should (eq (map-elt usage-hash "one") 1))
+ (should (eq (map-elt usage-hash "two") 2))
+ (should (eq (map-elt usage-hash "three") 3))
+ (should (eq (map-elt usage-hash "four") 4)))))
+
+(ert-deftest paced-populate-sort-order ()
+ "Test case for sorting after population."
+ (let* ((paced--registered-dictionaries nil)
+ (paced-global-dict-enable-alist '((text-mode . test-dict-case)))
+ (cmd (paced-file-population-command :file paced-first-test-file))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (eq (map-length usage-hash) 4))
+ (should (equal (map-keys usage-hash) '("four" "three" "two" "one")))
+ (should (eq (map-elt usage-hash "one") 1))
+ (should (eq (map-elt usage-hash "two") 2))
+ (should (eq (map-elt usage-hash "three") 3))
+ (should (eq (map-elt usage-hash "four") 4)))))
+
+(ert-deftest paced-populate-non-existent-file ()
+ (let* ((paced--registered-dictionaries nil)
+ (file "first.txt")
+ (cmd (paced-file-population-command :file file))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (map-empty-p usage-hash)))))
+
+(ert-deftest paced-populate-non-existent-buffer ()
+ (let* ((paced--registered-dictionaries nil)
+ (buffer "first.txt")
+ (cmd (paced-buffer-population-command :buffer buffer))
+ test-dict)
+ (paced-load-dictionary-from-file paced-test-dict-save-file)
+ (setq test-dict (paced-named-dictionary 'test-dict-case))
+ (should (paced-dictionary-p test-dict))
+ (oset test-dict population-commands (list cmd))
+ (paced-repopulate-dictionary test-dict)
+ (let ((usage-hash (oref test-dict usage-hash)))
+ (should (map-empty-p usage-hash)))))
+
+(provide 'paced-tests)
+
+;;; paced-tests.el ends here
diff --git a/paced.el b/paced.el
new file mode 100644
index 0000000..2623009
--- /dev/null
+++ b/paced.el
@@ -0,0 +1,844 @@
+;;; paced.el --- Predictive Abbreviation Completion and Expansion using
Dictionaries -*- lexical-binding: t; -*-
+
+;; Copyright (c) 2017 Ian Dunn
+
+;; Author: Ian Dunn <du...@gnu.org>
+;; Keywords: convenience, completion
+;; Version: 1.0
+;; Created: 22 Jan 2017
+;; Modified: 10 Nov 2017
+
+;; This file is NOT part of GNU Emacs.
+
+;; 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/>.
+
+;;; Commentary:
+
+;; Paced scans one or more files or buffers and constructs a table of words,
+;; weighted by how often they're used.
+
+;; Once it's constructed this table, it can present them to the user for
+;; completion, sorted by their weights.
+
+;; Creating a new dictionary is easy; just use `paced-create-new-dictionary' to
+;; create a new dictionary, then set the population commands and sort method.
+
+;; Dictionaries are persistent; they're saved with
+;; `paced-save-named-dictionary' or `paced-save-all-dictionaries'.
+
+;; Population commands tell a dictionary how it should refresh its usage table.
+;; The different types of populators are documented in
`paced--populator-alist'.
+
+;; No completion frontend is provided, but a function for
+;; `completion-at-point-functions' is given.
+
+;;; Code:
+
+(eval-when-compile (require 'subr-x))
+
+(require 'thingatpt)
+(require 'map)
+(require 'eieio-base)
+(require 'rx)
+
+(defgroup paced nil
+ "Predictive Abbreviation Completion and Expansion using Dictionaries"
+ :group 'convenience)
+
+(defcustom paced-thing-at-point-constituent 'symbol
+ "Symbol defining THING which function `paced-mode' works on.
+This symbol should be understandable by
+`bounds-of-thing-at-point'. This symbol defines what function `paced-mode'
+considers to be the basic unit of expansion. If if it set to `symbol',
+for example, \"paced-mode\" would be offered as an expansion, while
+if it is set to `word' \"paced\" and \"mode\" would be offered."
+ :group 'paced
+ :type 'symbol
+ :options '(symbol word))
+
+(defcustom paced-completion-ignore-case t
+ "Non-nil to ignore case when completing.
+
+Note that this does not affect dictionary population."
+ :group 'paced
+ :type 'boolean)
+
+(defcustom paced-dictionary-directory (locate-user-emacs-file
"paced-dictionaries/")
+ "Directory in which the dictionaries are saved.
+
+This is only used in `paced-load-all-dictionaries', so it's up to
+the user whether to save dictionaries here."
+ :group 'paced
+ :type 'directory)
+
+(defcustom paced-repopulate-saves-dictionary t
+ "Whether to save a dictionary after repopulation."
+ :group 'paced
+ :type 'boolean)
+
+
+
+(defun paced--default-dictionary-sort-func (usage-hash)
+ "Default dictionary sort function.
+
+Sort hash-table USAGE-HASH by the weights (values) in the table."
+ ;; Unfortunately, there's no way to sort a hash-table, so we first convert it
+ ;; into an alist, and sort that.
+ (let ((seq (map-into usage-hash 'list)))
+ (setq seq
+ (seq-sort
+ (pcase-lambda (`(_ . ,usage-lhs)
+ `(_ . ,usage-rhs))
+ (> usage-lhs usage-rhs))
+ seq))
+ (map-into seq 'hash-table)))
+
+(defclass paced-dictionary (eieio-named eieio-persistent)
+ ((object-name :initarg :object-name
+ :documentation "Symbol to use to refer to this dictionary.")
+ (usage-hash :initarg :usage-hash
+ :initform (make-hash-table :test #'equal)
+ :type hash-table
+ :documentation "Stores the usage data for this dictionary.")
+ (population-commands
+ :initarg :population-commands
+ :initform nil
+ :type (list-of paced-population-command)
+ :custom (repeat (object :objectcreatefcn
paced-new-population-command-custom))
+ :label "Population Commands"
+ :documentation "Commands to use when populating this dictionary.
+
+Each entry must be a list of the form (TYPE ARGS PROPS).
+
+TYPE is the type of populator; see `paced--populator-alist' for
+allowed entries here.
+
+ARGS is a list of arguments to pass to the populator, which are
+specific to the given populator.
+
+PROPS is a list of variables to let-bind when populating. Each
+entry should be of the form (VAR VALUE).")
+ (file-header-line :type string
+ :allocation :class
+ :initform ";; Paced Dictoinary"
+ :documentation
+ "Header line for the save file.
+This is used with the `object-write' method.")
+ (case-sensitive :initarg :case-sensitive
+ :initform nil
+ :type boolean
+ :custom boolean
+ :label "Case Sensitive"
+ :documentation "Non-nil if the dictionary should be case
sensitive when populating.
+
+When nil, \"This\" will be the same as \"this\" in `usage-hash'.")
+ (updated :initarg :updated
+ :initform nil
+ :type boolean
+ :documentation "Non-nil if this dictionary has been updated since
it was last saved.")
+ (sort-method :initarg :sort-method
+ :initform 'paced--default-dictionary-sort-func
+ :type function
+ :label "Sort Method"
+ :documentation "Method by which this dictionary should sort
its usage table.
+
+This should be a function of one argument, the usage-hash slot,
+and return a sorted hash-table.
+
+This defaults to `paced--default-dictionary-sort-func'."))
+ "Paced dictionary.")
+
+(defvar paced--registered-dictionaries nil
+ "Internal list of registered dictionaries.
+
+Do not edit this list manually. Use `paced-make-dictionary'
+instead.")
+
+(defsubst paced-named-dictionary (key)
+ (map-elt paced--registered-dictionaries key nil))
+
+(defsubst paced-dictionary-names ()
+ (map-keys paced--registered-dictionaries))
+
+(defsubst paced-read-dictionary ()
+ (intern (completing-read "Dictionary: " (map-keys
paced--registered-dictionaries))))
+
+(defsubst paced-dictionary-registered-p (key)
+ (map-contains-key paced--registered-dictionaries key))
+
+(defsubst paced-ensure-registered (key)
+ (unless (paced-dictionary-registered-p key)
+ (error "No paced dictionary called '%s' has been registered." key)))
+
+(defsubst paced-register-dictionary (key dict)
+ (map-put paced--registered-dictionaries key dict))
+
+(defsubst paced--ensure-dictionary-directory ()
+ (make-directory paced-dictionary-directory t))
+
+(defun paced-make-dictionary (name filename case-sensitive)
+ "Make a paced dictionary called NAME.
+
+NAME is a symbol used to identify the new dictionary.
+
+If a paced dictionary is already registered with name NAME, then
+it is replaced with a new, empty one.
+
+Return value is the new dictionary."
+ (let ((new-dict (paced-dictionary
+ :object-name name
+ :file filename
+ :case-sensitive case-sensitive)))
+ (paced-register-dictionary name new-dict)
+ new-dict))
+
+(defun paced-create-new-dictionary (name file)
+ "Create a new dictionary called NAME.
+
+FILE is the file in which to store the new dictionary.
+
+Once named, the dictionary can be edited through the EIEIO
+customization interface."
+ (declare (interactive-only paced-make-dictionary))
+ (interactive (list (intern (read-string "Name: "))
+ (read-file-name "Storage File: "
paced-dictionary-directory)))
+ (let ((new-dict (paced-dictionary :object-name name
+ :file file)))
+ (customize-object new-dict)))
+
+(cl-defmethod paced-dictionary-name ((obj paced-dictionary))
+ (oref obj object-name))
+
+(defcustom paced-global-dict-enable-alist nil
+ "Global enable list.
+
+Each entry has the form (CONDITION . DICT-KEY), where CONDITION
+is one of the following forms:
+
+- A mode name, such as `org-mode' or `text-mode', indicating that
+ the named dictionary should be active in any mode derived from
+ that mode.
+
+- A symbol, in which case the named dictionary is active whenever
+ the value of that symbol is non-nil.
+
+- A function symbol, in which case the function is called with no
+ arguments to determine if the given dictionary should be
+ enabled. If the function returns non-nil the dictionary is enabled.
+
+- A lambda function, in which case it is called with no
+ arguments, and if it returns non-nil, the dictionary is
+ enabled.
+
+- The form (or CONDITION1 CONDITION2 ...), which enables the
+ given dictionary if any of the conditions are met.
+
+- The form (and CONDITION1 CONDITION2 ...), which enables the
+ given dictionary if all of the conditions are met.
+
+No matter what this list indicates, dictionaries will not be
+enabled unless paced-mode is active."
+ :group 'paced
+ :type '(alist :key-type sexp :value-type sexp))
+
+(defvar-local paced-local-dict-enable-alist nil
+ "Local enable list.
+
+Has the same form as and takes priority over
+`paced-global-dict-enable-alist'.")
+
+(defun paced-dict-enable-list ()
+ (append paced-local-dict-enable-alist
+ paced-global-dict-enable-alist))
+
+(defun paced-test-dict-enable-condition (condition)
+ "Determines if CONDITION passes in the current buffer.
+
+See `paced-global-dict-enable-alist' for an explanation."
+ (pcase condition
+ ((and (pred symbolp)
+ (app symbol-name (rx "-mode" string-end)))
+ (derived-mode-p condition))
+ ((and (pred symbolp)
+ (pred boundp))
+ (symbol-value condition))
+ ((and (pred symbolp)
+ (pred fboundp))
+ (funcall condition))
+ ((pred functionp)
+ (funcall condition))
+ (`(or . ,rest)
+ (seq-some 'paced-test-dict-enable-condition rest))
+ (`(and . ,rest)
+ (seq-every-p 'paced-test-dict-enable-condition rest))))
+
+(defun paced-current-dictionary ()
+ "Determine the current dictionary.
+
+Returns nil if no dictionary should be enabled.
+
+If a dictionary is found in the list that doesn't exist, it will
+be skipped."
+ (let ((conditions (paced-dict-enable-list))
+ (dictionary))
+ (while (and conditions
+ (not dictionary))
+ (pcase-let* ((`(,condition . ,dict) (pop conditions)))
+ (when (and (paced-dictionary-registered-p dict)
+ (paced-test-dict-enable-condition condition))
+ (setq dictionary dict))))
+ (when dictionary
+ (paced-named-dictionary dictionary))))
+
+(cl-defmethod paced-save-dictionary ((dict paced-dictionary))
+ "Save dictionary DICT according to its filename."
+ (when (oref dict updated)
+ (eieio-persistent-save dict))
+ (oset dict updated nil))
+
+(defun paced-save-named-dictionary (key)
+ "Save dictionary named KEY."
+ (declare (interactive-only paced-save-dictionary))
+ (interactive (list (paced-read-dictionary)))
+ (paced-ensure-registered key)
+ (let ((dict (paced-named-dictionary key)))
+ (paced-save-dictionary dict)))
+
+(defun paced-load-dictionary-from-file (file)
+ "Load dictionary from FILE."
+ (interactive
+ (list (read-file-name "Dictionary File: " paced-dictionary-directory)))
+ (when-let* ((new-dict (eieio-persistent-read file 'paced-dictionary)))
+ (paced-register-dictionary
+ (paced-dictionary-name new-dict)
+ new-dict)))
+
+(defun paced-save-all-dictionaries ()
+ "Save all registered dictionaries."
+ (interactive)
+ (map-apply
+ (lambda (_ dict)
+ (paced-save-dictionary dict))
+ paced--registered-dictionaries))
+
+;;;###autoload
+(defun paced-load-all-dictionaries ()
+ "Load all dictionaries in `paced-dictionary-directory'."
+ (interactive)
+ (message "Loading all dictionaries from %s" paced-dictionary-directory)
+ (paced--ensure-dictionary-directory)
+ (dolist (dict-file (directory-files paced-dictionary-directory t))
+ (when (file-regular-p dict-file)
+ (paced-load-dictionary-from-file dict-file))))
+
+(cl-defmethod eieio-done-customizing ((dict paced-dictionary))
+ ;; TODO validate options
+ (paced-register-dictionary (paced-dictionary-name dict) dict)
+ (paced--ensure-dictionary-directory)
+ (paced-save-dictionary dict))
+
+
+
+(defvar-local paced--current-source nil
+ "The source from which a dictionary is being populated.
+
+This is used internally to inform the user of the current source,
+since population mostly uses temporary buffers.")
+
+(defvar-local paced-exclude-function (lambda () nil)
+ "Local predicate to determine if thing at point should be excluded.
+
+This should be a function of no arguments that returns non-nil if
+the current thing-at-point should be excluded from paced dictionaries.
+
+By default, this allows everything.")
+
+(defun paced-excluded-p ()
+ "Return non-nil to exclude current thing at point.
+
+See `paced-exclude-function' for more."
+ (funcall paced-exclude-function))
+
+(defun paced-bounds-of-thing-at-point ()
+ "Get the bounds of the thing at point."
+ (bounds-of-thing-at-point paced-thing-at-point-constituent))
+
+(defun paced-thing-at-point ()
+ "Return the current thing at point.
+
+The thing is determined by `paced-thing-at-point-constituent'.
+
+Text properties are excluded."
+ (when-let* ((bounds (paced-bounds-of-thing-at-point)))
+ (buffer-substring-no-properties
+ (car bounds) (cdr bounds))))
+
+(defun paced-forward-thing (&optional number)
+ "Move forward NUMBER things.
+
+Things is based on `paced-thing-at-point-constituent'."
+ (interactive "p")
+ (forward-thing paced-thing-at-point-constituent number))
+
+(defsubst paced-add-word-to-dict (dict word)
+ "Add WORD to paced dictionary DICT."
+ ;; If I've got a word uppercase and lowercase in my usage table, I'm
+ ;; going to have repeats when ignore case is enabled. To solve this,
+ ;; downcase everything when not case sensitive.
+ (let ((new-word (if (oref dict case-sensitive) word (downcase word))))
+ ;; Use the full name here to silence the byte-compiler
+ (cl-incf (map-elt (oref dict usage-hash) new-word 0))
+ (oset dict updated t)))
+
+(defsubst paced-add-word-to-current-dict (word)
+ "Add WORD to the current paced dictionary."
+ (if-let* ((dict (paced-current-dictionary)))
+ (paced-add-word-to-dict dict word)
+ (error "No dictionary found")))
+
+(cl-defmethod paced-populate-dictionary-from-buffer ((dict paced-dictionary)
&optional buffer)
+ (with-current-buffer (or buffer (current-buffer))
+ (save-excursion
+ (goto-char (point-min))
+ (let* ((reporter-string
+ (concat (format "Populating dictionary %s"
(paced-dictionary-name dict))
+ (when paced--current-source (format " from %s"
+
paced--current-source))
+ "..."))
+ (reporter (make-progress-reporter reporter-string 0 100)))
+ (while (paced-forward-thing)
+ (progress-reporter-do-update
+ reporter
+ (floor (* 100.0 (/ (float (point)) (point-max)))))
+ (unless (paced-excluded-p)
+ (paced-add-word-to-dict dict (paced-thing-at-point))))
+ (progress-reporter-done reporter)))))
+
+(defun paced-populate-dictionary-from-region (dict start end)
+ "Populate DICT from the region in the current buffer between START and END.
+
+Note that this doesn't add the current buffer to DICT's
+population commands, so if DICT is later repopulated using
+`paced-repopulate-dictionary' or
+`paced-repopulate-named-dictionary', anything added with this
+command will be lost."
+ (save-restriction
+ (narrow-to-region start end)
+ (paced-populate-dictionary-from-buffer dict)))
+
+(defun paced-populate-buffer-dictionary (&optional buffer)
+ "Populate BUFFER's current dictionary with BUFFER.
+
+This means add a usage of each included thing in buffer.
+
+If called interactively, the current buffer is used. In order to
+only populate the dictionary from a region,
+`paced-populate-from-region'.
+
+Note that this doesn't add BUFFER to the dictionary's population
+commands, so if it is later repopulated using
+`paced-repopulate-dictionary' or
+`paced-repopulate-named-dictionary', anything added with this
+command will be lost.
+
+In order to make changes permanent, use
+`paced-add-buffer-file-to-dictionary'."
+ (interactive)
+ (if-let* ((dict (paced-current-dictionary)))
+ (paced-populate-dictionary-from-buffer dict buffer)
+ (user-error "No dictionary found")))
+
+(defun paced-populate-from-region (start end)
+ "Populate the current dictionary from the region START to END.
+
+Note that this doesn't add the current buffer to the dictionary's
+population commands, so if it is later repopulated using
+`paced-repopulate-dictionary' or
+`paced-repopulate-named-dictionary', anything added with this
+command will be lost."
+ (interactive "r")
+ (if-let* ((dict (paced-current-dictionary)))
+ (paced-populate-dictionary-from-region dict start end)
+ (user-error "No dictionary found")))
+
+(defun paced-add-current-thing-to-dict ()
+ "Add the current thing at point to the current dictionary.
+
+No check is done to determine if the current thing should be
+excluded.
+
+Note that this doesn't add anything to the dictionary's
+population commands, so if it is later repopulated using
+`paced-repopulate-dictionary' or
+`paced-repopulate-named-dictionary', anything added with this
+command will be lost."
+ (interactive)
+ (paced-add-word-to-current-dict (paced-thing-at-point)))
+
+(cl-defmethod paced-reset-dictionary ((dict paced-dictionary))
+ "Reset the usage-hash of paced-dictionary DICT."
+ (oset dict usage-hash (oref-default dict usage-hash)))
+
+(defun paced-reset-named-dictionary (key)
+ "Reset the paced dictionary with key KEY."
+ (interactive
+ (list (paced-read-dictionary)))
+ (paced-ensure-registered key)
+ (let ((dict (paced-named-dictionary key)))
+ (paced-reset-dictionary dict)))
+
+(cl-defmethod paced-sort-dictionary ((dict paced-dictionary))
+ (oset dict usage-hash
+ (funcall (oref dict sort-method)
+ (oref dict usage-hash))))
+
+(defun paced-sort-named-dictionary (key)
+ (interactive (list (paced-read-dictionary)))
+ (paced-ensure-registered key)
+ (let ((dict (paced-named-dictionary key)))
+ (paced-sort-dictionary dict)))
+
+
+
+(define-minor-mode paced-mode
+ "Toggle paced mode.
+
+This adds `paced-completion-at-point' to
+`completion-at-point-functions'."
+ :init-value nil
+ :lighter " paced"
+ :group 'paced
+ (if paced-mode
+ (add-hook 'completion-at-point-functions 'paced-completion-at-point
'append 'local)
+ (remove-hook 'completion-at-point-functions 'paced-completion-at-point
'local)))
+
+(define-globalized-minor-mode global-paced-mode paced-mode paced-mode
+ :group 'paced)
+
+
+ ; ;;;;;;;;;;;;;;;; ;
+ ; ;; Completion ;; ;
+ ; ;;;;;;;;;;;;;;;; ;
+
+(cl-defmethod paced-dictionary-completions-for-prefix ((dict paced-dictionary)
prefix)
+ (let* ((completion-ignore-case paced-completion-ignore-case)
+ (prefix-length (length prefix)))
+ ;; Account for case differences in the prefix by prepending the prefix.
+ (mapcar
+ (lambda (completion)
+ (when (stringp completion)
+ (concat prefix (substring-no-properties completion prefix-length))))
+ (all-completions prefix (oref dict usage-hash)))))
+
+(defun paced-completions-for-prefix (prefix)
+ "Get completions for PREFIX from the current dictionary."
+ (if-let* ((dict (paced-current-dictionary)))
+ (paced-dictionary-completions-for-prefix dict prefix)
+ (user-error "No dictionary found")))
+
+(defun paced-completion-finish (prefix completions)
+ "Account for case differences in the prefix by prepending the prefix."
+ (cond
+ ((not (listp completions))
+ ;; If completions is not a list, it's likely 't', in which
+ ;; case just return the original prefix.
+ (list prefix))
+ (t
+ (let ((prefix-length (length prefix)))
+ (mapcar
+ (lambda (completion)
+ (when (stringp completion)
+ (concat prefix (substring-no-properties completion prefix-length))))
+ completions)))))
+
+(defun paced-completion-table-function (string pred action)
+ (if-let* ((dict (paced-current-dictionary)))
+ (let* ((completion-ignore-case paced-completion-ignore-case))
+ (pcase action
+ (`nil
+ (paced-completion-finish string
+ (try-completion string (oref dict
usage-hash) pred)))
+ (`t
+ (paced-completion-finish string
+ (all-completions string (oref dict
usage-hash) pred)))
+ (`lambda
+ (paced-completion-finish string
+ (test-completion string (oref dict
usage-hash) pred)))
+ (`(boundaries . _) nil)
+ (`metadata
+ `(metadata . ((category . paced)
+ (annotation-function . nil)
+ (display-sort-function . identity)
+ (cycle-sort-function . identity))))))
+ (user-error "No dictionary found for current buffer")))
+
+(defcustom paced-auto-update-p nil
+ "Whether to update from completions.
+
+This only works for an existing entry."
+ :group 'paced
+ :type 'boolean)
+
+(defun paced-completion-auto-update (word status)
+ (cl-case status
+ (sole
+ ;; We're done with completion, but the user may still be typing.
+ ;; Therefore, don't add it.
+ )
+ (exact
+ ;; Might not be the entire completion, so don't add it.
+ )
+ (finished
+ (when paced-auto-update-p
+ (paced-add-word-to-current-dict word)))))
+
+(defun paced-completion-at-point ()
+ "Function for `completion-at-point-functions' to get the paced completions"
+ ;; Don't expand unless we're in a buffer with paced-mode enabled.
+ (when (and paced-mode)
+ (when-let* ((bounds (paced-bounds-of-thing-at-point)))
+ (list (car bounds) (cdr bounds) 'paced-completion-table-function
+ :exit-function 'paced-completion-auto-update))))
+
+
+ ; ;;;;;;;;;;;;;;;;;; ;
+ ; ;; Repopulation ;; ;
+ ; ;;;;;;;;;;;;;;;;;; ;
+
+(defun paced--insert-file-contents (file)
+ "Inserts the contents of FILE into the current buffer.
+
+Unlike `insert-file-contents', this handles mode hooks, which
+paced requires for repopulation (syntax tables, exclude functions, etc.).
+
+Returns nil if FILE doesn't exist."
+ (if (not (file-exists-p file))
+ (progn (message "Paced couldn't find file %s" file) nil)
+ (insert-file-contents file)
+ (let ((buffer-file-name file))
+ (after-find-file))
+ t))
+
+(defclass paced-population-command ()
+ ((props :initarg :props
+ :initform nil
+ :type list
+ :label "Properties"
+ :custom (alist :tag "Options" :key-type variable :value-type sexp)
+ :documentation "A list of variables to set during population.
+
+Each element is of the form (VAR VALUE).")))
+
+(cl-defmethod paced-population-command-prepare-props ((cmd
paced-population-command))
+ "Turn props of CMD into a form understood by `let'."
+ (with-slots (props) cmd
+ (map-apply (lambda (var val) (list var val)) props)))
+
+(cl-defgeneric paced-population-command-source-list ((_cmd
paced-population-command)))
+
+(cl-defgeneric paced-population-command-setup-buffer ((_cmd
paced-population-command) _source)
+ "Prepare a temporary buffer with SOURCE.
+
+Return non-nil if setup was successful and population can continue.")
+
+(cl-defmethod paced-population-command-populate-dictionary ((dict
paced-dictionary) (cmd paced-population-command))
+ (let ((sources (paced-population-command-source-list cmd))
+ ;; Turn props into a form understood by `let'.
+ (props (paced-population-command-prepare-props cmd)))
+ (dolist (source sources)
+ (with-temp-buffer
+ ;; If pre is nil, continue.
+ ;; Otherwise, continue if pre returns non-nil
+ ;; This allows users to specify conditions under which repopulation
+ ;; should be disabled.
+ (let ((paced--current-source source))
+ (when (paced-population-command-setup-buffer cmd source)
+ (eval (macroexp-let* props `(paced-populate-dictionary-from-buffer
,dict)))))))))
+
+(defclass paced-file-population-command (paced-population-command)
+ ((file :initarg :file
+ :initform ""
+ :type string
+ :label "File"
+ :custom (file :tag "File")
+ :documentation "File from which to populate.")))
+
+(cl-defmethod paced-population-command-source-list ((cmd
paced-file-population-command))
+ (list (oref cmd file)))
+
+(cl-defmethod paced-population-command-setup-buffer ((_cmd
paced-file-population-command) source)
+ (paced--insert-file-contents source))
+
+(defclass paced-buffer-population-command (paced-population-command)
+ ((buffer :initarg :buffer
+ :initform ""
+ :type string
+ :label "Buffer"
+ :custom (string :tag "Buffer")
+ :documentation "Name of the buffer from which to populate.")))
+
+(cl-defmethod paced-population-command-source-list ((cmd
paced-buffer-population-command))
+ (list (oref cmd buffer)))
+
+(cl-defmethod paced-population-command-setup-buffer ((_cmd
paced-buffer-population-command) source)
+ (cond
+ ((not (stringp source))
+ (message "Paced buffer populator got an invalid argument: %s" source)
+ nil)
+ ((not (get-buffer source))
+ (message "Paced buffer populator got a buffer that doesn't exist: %s"
source)
+ nil)
+ (t
+ (set-buffer source))))
+
+(defclass paced-file-function-population-command (paced-population-command)
+ ((file :initarg :file
+ :initform ""
+ :type string
+ :label "File"
+ :custom (file :tag "File")
+ :documentation "File from which to populate.")
+ (setup-func :initarg :setup-func
+ :initform (lambda () t)
+ :type function
+ :label "Setup Function"
+ :custom (function :tag "Setup Function")
+ :documentation "Additional setup function.")))
+
+(cl-defmethod paced-population-command-source-list ((cmd
paced-file-function-population-command))
+ (list (oref cmd file)))
+
+(cl-defmethod paced-population-command-setup-buffer ((cmd
paced-file-function-population-command) source)
+ (and (paced--insert-file-contents source)
+ (funcall (oref cmd setup-func))))
+
+(defclass paced-directory-regexp-population-command (paced-population-command)
+ ((directory :initarg :directory
+ :initform ""
+ :type string
+ :label "Directory"
+ :custom (directory :tag "Directory")
+ :documentation "Directory to search for files from which to
populate.")
+ (regexp :initarg :regexp
+ :initform ".*"
+ :type string
+ :label "File Regexp"
+ :custom (string :tag "File Regexp")
+ :documentation "Regular expression to match files.")
+ (recursive :initarg :recursive
+ :initform t
+ :type boolean
+ :label "Recursive"
+ :custom boolean
+ :documentation "Whether to search through the directory
recursively."))
+ "Population command to populate from files in a directory that
+match a regular expression.")
+
+(cl-defmethod paced-population-command-source-list ((cmd
paced-directory-regexp-population-command))
+ (with-slots (directory regexp recursive) cmd
+ (if recursive
+ (directory-files-recursively directory regexp)
+ (directory-files directory t regexp))))
+
+(cl-defmethod paced-population-command-setup-buffer ((_cmd
paced-directory-regexp-population-command) source)
+ (paced--insert-file-contents source))
+
+(defclass paced-file-list-population-command (paced-population-command)
+ ((generator :initarg :generator
+ :initform (lambda () nil)
+ :type function
+ :label "Generator"
+ :custom (function :tag "Generator")
+ :documentation "Function of no arguments that returns a list of
files.")))
+
+(cl-defmethod paced-population-command-source-list ((cmd
paced-file-list-population-command))
+ (funcall (oref cmd generator)))
+
+(cl-defmethod paced-population-command-setup-buffer ((_cmd
paced-file-list-population-command) source)
+ (paced--insert-file-contents source))
+
+(defun paced-new-population-command-custom ()
+ (let* ((type (completing-read "Command Type: "
+ (eieio-class-children
'paced-population-command))))
+ (funcall (intern type))))
+
+(cl-defmethod paced-repopulate-dictionary ((dict paced-dictionary))
+ "Repopulate dictionary DICT from its population commands.
+
+Population commands are stored in the field of the same name.
+
+Note that this will empty the dictionary's contents before
+repopulating it."
+ ;; Empty the dictionary
+ (paced-reset-dictionary dict)
+ (dolist (cmd (oref dict population-commands))
+ (paced-population-command-populate-dictionary dict cmd))
+ (paced-sort-dictionary dict)
+ (when paced-repopulate-saves-dictionary
+ (paced-save-dictionary dict)))
+
+(defun paced-repopulate-named-dictionary (key)
+ "Repopulate dictionary named KEY from its population commands.
+
+Population commands are stored in the field of the same name.
+
+Note that this will empty the dictionary's contents before
+repopulating it."
+ (interactive
+ (list (paced-read-dictionary)))
+ (paced-ensure-registered key)
+ (let ((dict (paced-named-dictionary key)))
+ ;; TODO: Warn about reset.
+ (paced-repopulate-dictionary dict)))
+
+(defun paced-add-buffer-file-to-dictionary (&optional buffer)
+ "Populate the dictionary of BUFFER with BUFFER.
+
+The file corresponding to BUFFER is then added to the current
+dictionary's population commands.
+
+Custom settings for the populator, such as the exclude function,
+must be set with `paced-edit-named-dictionary' or
+`paced-edit-current-dictionary'."
+ (interactive)
+ (with-current-buffer (or buffer (current-buffer))
+ (unless (buffer-file-name)
+ (user-error "paced-add-buffer-file-to-dictionary called inside a
non-file buffer."))
+ (if-let* ((dict (paced-current-dictionary))
+ (file-name (buffer-file-name))
+ (cmd (paced-file-population-command :file file-name)))
+ (progn
+ (paced-populate-dictionary-from-buffer dict buffer)
+ (cl-pushnew cmd (oref dict population-commands) :test 'equal))
+ (user-error "No dictionary found for current buffer."))))
+
+
+
+(defun paced-edit-named-dictionary (name)
+ "Edit the paced-dictionary named NAME."
+ (interactive (list (paced-read-dictionary)))
+ (if-let* ((dict (paced-named-dictionary name)))
+ (customize-object dict)
+ (error "No paced dictionary called '%s' has been registered." name)))
+
+(defun paced-edit-current-dictionary ()
+ "Edit the current paced dictoinary."
+ (interactive)
+ (if-let* ((dict (paced-current-dictionary)))
+ (customize-object dict)
+ (user-error "No dictionary found for current buffer")))
+
+(provide 'paced)
+
+;;; paced.el ends here
diff --git a/paced.org b/paced.org
new file mode 100644
index 0000000..6c4985f
--- /dev/null
+++ b/paced.org
@@ -0,0 +1,169 @@
+#+TITLE: Paced
+#+AUTHOR: Ian Dunn
+#+EMAIL: du...@gnu.org
+#+DATE: {{{modification-time}}}
+
+#+STARTUP: overview
+#+STARTUP: indent
+#+TODO: FIXME | FIXED
+#+OPTIONS: toc:2 num:nil timestamp:nil \n:nil |:t ':t email:t
+#+OPTIONS: *:t <:t d:nil todo:nil pri:nil tags:not-in-toc
+
+#+TEXINFO_DIR_CATEGORY: Emacs
+#+TEXINFO_DIR_TITLE: paced
+#+TEXINFO_DIR_DESC: Predictive Abbreviation Completion and Expansion using
Dictionaries
+
+
+* Copying
+Copyright (C) 2017 Ian Dunn
+
+#+BEGIN_QUOTE
+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/>.
+#+END_QUOTE
+* Introduction
+Paced (Predictive Abbreviation Completion and Expansion using Dictionaries)
+provides a completion backend based on what a user has already written.
+
+Paced scans one or more files or buffers and constructs a table of words,
+weighted by how often they're used.
+
+Once it's constructed this table, it can present them to the user for
+completion, sorted by their weights.
+
+Creating a new dictionary is easy; just use ~paced-create-new-dictionary~ to
+create a new dictionary, then set the population commands and sort method.
+
+Dictionaries are persistent; they're saved with ~paced-save-named-dictionary~
or
+~paced-save-all-dictionaries~.
+
+Population commands tell a dictionary how it should refresh its usage table.
+The different types of populators are documented in ~paced--populator-alist~.
+
+No completion frontend is provided, but a function for
+~completion-at-point-functions~ is given.
+
+** Terminology
+
+- Dictionary :: A collection of words and their usage counts.
+
+- Populator :: A method of loading a file into a dictionary.
+
+** Similar Packages
+There are a few Emacs packages that have similar goals to paced, and provided
+some of the inspiration and motivation behind it.
+*** pabbrev
+The [[http://github.com/phillord/pabbrev][pabbrev]] package by Phillip Lord
scans text of the current buffer while Emacs
+is idle and presents the user with the most common completions.
+
+One of the major downsides to pabbrev is that the data it collects doesn't
+persist between Emacs sessions. For a few files that are always open, such as
+org agenda files, pabbrev works great. For files that aren't always open, like
+prose or source files, you've got to retrain pabbrev every time you restart
+Emacs.
+
+The benefit of pabbrev dies down if the suggested word isn't the one you need.
+Then you've still got to search through a list of suggestions, which takes away
+from typing.
+
+That's not to say that pabbrev is all bad. It keeps up-to-date usage and
prefix
+hashes of all buffers of the same mode, and scanning, or "scavenging", blends
+seamlessly into the background. Completion is just a hash table lookup, so it
+can handle completion in microseconds.
+*** predictive
+The [[http://www.dr-qubit.org/git/predictive.git][predictive]] package by Toby
Cubitt scans text of the current buffer on user
+command. The usage data is stored in a dictionary, which can then be saved to
a
+disk. Extensions are provided to ~completion-at-point~, or predictive's
built-in
+frontend can be used. It has a safety precaution where it only adds existing
+words to a dictionary, unless the user allows this. This is to avoid adding
+typos to a dictionary.
+
+Completion was also done intelligently, grouping commonly used words together
+and optionally suggesting shorter words before longer words.
+
+While the frontend and backend are separate, the frontend is required to
+populate a dictionary. There is no way to exclude part of the buffer's text
+from dictionary population. The safety precaution predictive has where it only
+adds a word to a dictionary if it already exists was tedious, since I didn't
+need it to do that.
+** Installation
+
+*Requirements*
+
+| Emacs | 26.1 |
+| async | 1.9.2 |
+
+There are two ways to install paced; From GNU ELPA, or from source.
+
+From ELPA:
+
+#+begin_example
+M-x package-install paced
+#+end_example
+
+From Source:
+
+#+begin_src shell
+bzr branch https://bzr.savannah.gnu.org/r/paced-el paced
+cd paced
+./bootstrap.sh
+make all
+#+end_src
+
+After that, add the following to your init file (typically .emacs):
+
+#+BEGIN_SRC emacs-lisp
+;; Only necessary if installing from source
+(add-to-list 'load-path "/full/path/to/paced/")
+(load "paced-autoloads.el")
+#+END_SRC
+** Creating a Dictionary
+
+Now that you've got paced installed, it's time to create a new dictionary.
+
+#+begin_example
+M-x paced-create-new-dictionary RET DICTIONARY_NAME RET DICTIONARY_FILE RET
+#+end_example
+
+Let's explain those two arguments:
+
+First, you've got DICTIONARY_NAME. This is a key that will be used to
reference
+the new dictionary. It's a symbol, so it should adhere to Emacs's symbol
syntax
+(no dots or quotes, etc.). We recommend something short, like 'new-dict',
+'my-dict', 'writing'.
+
+Next is the file where the dictionary will be stored. This is typically stored
+in ~paced-dictionary-directory~, from which all dictionaries will be loaded
with
+~paced-load-all-dictionaries~ (more on that later). For now, it's important to
+know that ~paced-load-all-dictionaries~ is the easiest way to load dictionaries
+when paced is loaded.
+
+After you've run the above command, you will be taken to the customization
+buffer. This is where you can set population commands.
+** Editing a Dictionary
+In order to edit a dictionary, paced provides ~paced-edit-named-dictionary~ and
+~paced-edit-current-dictionary~.
+
+The edit buffer provides the options to change the population commands, case
+sensitivity, dictionary storage name, and sort method. Each of these is
+documented in the edit buffer.
+
+* Dictionaries
+** Enable Certain Dictionaries in Certain Places
+
+Paced provides a mechanism called the "enable list", that allows a user to
+enable certain dictionaries given certain conditions.
+
+There are two enable lists: a global and local one.
+
+* Population Commands
diff --git a/test-files/first.txt b/test-files/first.txt
new file mode 100644
index 0000000..d20283f
--- /dev/null
+++ b/test-files/first.txt
@@ -0,0 +1 @@
+one two three four two three four three four four
diff --git a/test-files/second.cpp b/test-files/second.cpp
new file mode 100644
index 0000000..2078554
--- /dev/null
+++ b/test-files/second.cpp
@@ -0,0 +1 @@
+// empty file that doesn't inherit from text mode
diff --git a/test-files/third.org b/test-files/third.org
new file mode 100644
index 0000000..8c15311
--- /dev/null
+++ b/test-files/third.org
@@ -0,0 +1 @@
+five five five five five six six seven six
diff --git a/test.mk b/test.mk
new file mode 100644
index 0000000..34de4f6
--- /dev/null
+++ b/test.mk
@@ -0,0 +1,27 @@
+# Copyright (C) 2017 Ian Dunn
+
+# 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/>.
+
+# EDE only allows arbitrary code from an external makefile, so this is how
we've
+# got to do testing.
+
+test:
+ @$(EMACS) \
+ $(EMACSFLAGS) \
+ -L "." \
+ --load "ert" \
+ --load "paced-tests.el" \
+ -f ert-run-tests-batch-and-exit
+
+include Makefile
