branch: elpa/extmap
commit 49e1e2f9448b040db61f969e776d7f332b36374d
Author: Paul Pogonyshev <pogonys...@gmail.com>
Commit: Paul Pogonyshev <pogonys...@gmail.com>
Initial commit.
---
.gitignore | 2 +
.travis.yml | 16 ++
LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++
README.md | 67 ++++++
extmap.el | 307 ++++++++++++++++++++++++
run-tests.sh | 21 ++
test/extmap-test.el | 52 ++++
7 files changed, 1139 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000..fbf1940f75
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+*.elc
+test/*.extmap
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000000..6566966516
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,16 @@
+language: emacs-lisp
+
+before_install:
+ # For Emacs 25.
+ - sudo add-apt-repository ppa:kelleyk/emacs -y
+ # For snapshot builds.
+ - sudo add-apt-repository ppa:ubuntu-elisp/ppa -y
+ - sudo apt-get update -q
+ - sudo apt-get install -q -y ${EMACS}
+
+env:
+ - EMACS=emacs25
+ - EMACS=emacs-snapshot
+
+script:
+ ./run-tests.sh
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000000..94a9ed024d
--- /dev/null
+++ b/LICENSE
@@ -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/README.md b/README.md
new file mode 100644
index 0000000000..6cb5f93328
--- /dev/null
+++ b/README.md
@@ -0,0 +1,67 @@
+[](http://www.gnu.org/licenses/gpl-3.0.txt)
+[](http://travis-ci.org/doublep/extmap)
+
+
+# extmap
+
+`extmap` is a very simple package that lets you build a *read-only*,
+*constant* database that maps Elisp symbols to almost arbitrary Elisp
+objects. The idea is to avoid preloading all data to memory and only
+retrieve it when needed.
+
+This package doesn’t use any external programs, making it a suitable
+dependency for smaller libraries.
+
+
+## Creating a map
+
+Creating disk maps doesn’t involve any additional tools and can be
+done from Elisp. Here is a trivial example:
+
+ (extmap-from-alist "mycool.extmap"
+ '((foo . 42)
+ (bar . (we (can (store [almost "anything"]))))))
+
+By default, function refuses to work if the output file already
+exists. However, you can tell it to overwrite it instead:
+
+ (extmap-from-alist ... :overwrite t)
+
+
+## Using a map
+
+Using a map is also easy. First, you need to initialize it:
+
+ (extmap-init "mycool.extmap")
+
+Keep in mind that the file must exist for as long as you use the map:
+the whole point is that it loads missing data on-demand.
+
+Now that you have map object, you can retrieve values from it:
+
+ (let ((extmap (extmap-init "mycool.extmap")))
+ (extmap-get extmap 'bar))
+
+You don’t need to care if a value is already in memory or not: the map
+will load it for you when necessary.
+
+
+## Other functions
+
+All the functions in the package are documented within Emacs (the
+three demonstrated above also have more information). Here is just a
+full list:
+
+* Using maps:
+ - `extmap-init`
+ - `extmap-get`
+ - `extmap-contains-key`
+ - `extmap-value-loaded`
+ - `extmap-keys`
+ - `extmap-mapc`
+ - `extmap-mapcar`
+ - `extmap-statistics`
+
+* Creating maps:
+ - `extmap-from-alist`
+ - `extmap-from-iterator`
diff --git a/extmap.el b/extmap.el
new file mode 100644
index 0000000000..e8629a704d
--- /dev/null
+++ b/extmap.el
@@ -0,0 +1,307 @@
+;;; extmap.el --- Externally-stored constant mapping for Elisp -*-
lexical-binding: t -*-
+
+;; Copyright (C) 2018 Paul Pogonyshev
+
+;; Author: Paul Pogonyshev <pogonys...@gmail.com>
+;; Maintainer: Paul Pogonyshev <pogonys...@gmail.com>
+;; Version: 0.9
+;; Keywords: lisp
+;; Homepage: https://github.com/doublep/extmap
+;; Package-Requires: ((emacs "25.1"))
+
+;; 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:
+
+;; Mapping of symbols to constants that is stored externally and
+;; loaded on-demand. Should be used for huge databases to avoid
+;; loading everything to memory. This package doesn't use any
+;; external programs, making it a suitable dependency for smaller
+;; libraries.
+
+
+;;; Code:
+
+(require 'bindat)
+(require 'generator)
+
+
+(defconst extmap--header-bindat-spec '((magic u16)
+ (version u16)
+ (num-items u32)
+ (offset u32)))
+
+;; TYPE can be:
+;; 0 -- inlined string (short specification is used);
+;; 1 -- inlined Lisp object (short specification is used);
+;; 2 -- string;
+;; 3 -- Lisp object.
+(defconst extmap--item-short-bindat-spec '((type u8)
+ (length u24)))
+(defconst extmap--item-bindat-spec '((type u8)
+ (length u24)
+ (offset u32)))
+
+
+(defun extmap-init (filename &optional weak-data)
+ "Load metadata of a previously created map from FILENAME.
+
+Loaded metadata can be further passed to `extmap-get' and other
+functions. It must be treated as an opaque object: you must not
+alter it or make any assumptions about its contents.
+
+If WEAK-DATA is non-nil, loaded values are stored in a weak
+hashmap and can be garbage-collected by Emacs if no longer used.
+This allows to potentially reduce memory usage at the cost of
+more disk operations.
+
+The file must remain accessible in case `extmap-get' needs to
+load a value later. There is no need to somehow close a map:
+just stop using it."
+ (with-temp-buffer
+ (let* ((header-length (bindat-length extmap--header-bindat-spec
nil))
+ (item-short-header-length (bindat-length
extmap--item-short-bindat-spec nil))
+ (item-header-length (bindat-length extmap--item-bindat-spec
nil))
+ (read-as (insert-file-contents-literally filename
nil 0 header-length))
+ (filename (car read-as))
+ (header (when (equal (cadr read-as)
header-length) (bindat-unpack extmap--header-bindat-spec (encode-coding-string
(buffer-string) 'no-conversion))))
+ items)
+ (erase-buffer)
+ (unless (= (bindat-get-field header 'magic) #x91f7)
+ (error "Wrong or corrupted extmap in file `%s'" filename))
+ (unless (= (bindat-get-field header 'version) 0)
+ (error "Future version of extmap in file `%s', upgrade your `extmap'
package" filename))
+ (setq items (make-hash-table :test #'eq :size (bindat-get-field header
'num-items)))
+ (insert-file-contents-literally filename nil (bindat-get-field header
'offset))
+ (dotimes (_ (bindat-get-field header 'num-items))
+ (let* ((key (intern (decode-coding-string
(buffer-substring-no-properties (point) (1- (re-search-forward (rx 0)))) 'utf-8
t)))
+ (item-header (bindat-unpack extmap--item-short-bindat-spec
(encode-coding-string (buffer-substring-no-properties (point) (+ (point)
item-short-header-length)) 'no-conversion)))
+ (type (bindat-get-field item-header 'type))
+ (length (bindat-get-field item-header 'length)))
+ (if (<= type 1)
+ ;; Inlined item.
+ (let ((value (decode-coding-string
(buffer-substring-no-properties (+ (point) item-short-header-length) (+ (point)
item-short-header-length length)) 'utf-8 t)))
+ (goto-char (+ (point) item-short-header-length length))
+ (when (= type 1)
+ (setq value (car (read-from-string value))))
+ (puthash key (cons t value) items))
+ ;; Non-inlined item.
+ (let ((item-header (bindat-unpack extmap--item-bindat-spec
(encode-coding-string (buffer-substring-no-properties (point) (+ (point)
item-header-length)) 'no-conversion))))
+ (goto-char (+ (point) item-header-length))
+ (puthash key (cons nil (cons type (cons (bindat-get-field
item-header 'offset) length))) items)))))
+ (list filename items (when weak-data (make-hash-table :test #'eq
:weakness 'value))))))
+
+(defun extmap-get (extmap key &optional no-error)
+ "Get value associated with KEY from the map.
+
+EXTMAP must be a result of a previous call to `extmap-init'. KEY
+should be a symbol present in the map. If it is not, function
+signals an error, unless NO-ERROR is specified, in which case it
+returns nil."
+ (let* ((items (nth 1 extmap))
+ (weak-data (nth 2 extmap))
+ ;; A key cannot be mapped to `items' table itself, we use
+ ;; that as a marker for "no mapping" situation.
+ (value items))
+ (when weak-data
+ (setq value (gethash key weak-data items)))
+ (if (eq value items)
+ (progn (setq value (gethash key items))
+ (if value
+ (if (car value)
+ ;; Already loaded.
+ (cdr value)
+ ;; Load now.
+ (let ((coding-system-for-read 'utf-8)
+ (offset (caddr value)))
+ (with-temp-buffer
+ (insert-file-contents (nth 0 extmap) nil offset (+
offset (cdddr value)))
+ (let ((new-value (if (= (cadr value) 2)
(buffer-string) (read (current-buffer)))))
+ (if weak-data
+ (puthash key new-value weak-data)
+ (prog1 (setcdr value new-value)
+ (setcar value t)))))))
+ (unless no-error
+ (error "No value for key `%s'" key))))
+ value)))
+
+(defun extmap-contains-key (extmap key)
+ "Determine if there is a mapping for given KEY in EXTMAP."
+ (consp (gethash key (nth 1 extmap))))
+
+(defun extmap-value-loaded (extmap key)
+ "Determine if value for given KEY is loaded in EXTMAP.
+If there is no mapping for KEY, this function always returns
+nil.
+
+In case the map has been initialized with WEEK-DATA argument, it
+may happen that this function returns t, but value for the KEY
+has to be loaded again in the future."
+ (or (car-safe (gethash key (nth 1 extmap)))
+ (let ((weak-data (nth 2 extmap)))
+ (when weak-data
+ (not (eq (gethash key weak-data weak-data) weak-data))))))
+
+(defun extmap-keys (extmap)
+ "Return a list of all the keys in the map.
+The list is in no particular order.
+
+EXTMAP must be a result of a previous call to `extmap-init'."
+ (let (keys)
+ (maphash (lambda (key _value) (push key keys)) (nth 1 extmap))
+ keys))
+
+(defun extmap-mapc (extmap callback)
+ "Invoke CALLBACK on each key-value pairing in the map.
+
+EXTMAP must be a result of a previous call to `extmap-init'.
+
+CALLBACK is called with two arguments: KEY and VALUE. Its return
+value is ignored. Values in the map are enumerated in no
+particular order.
+
+Note that unless CALLBACK exits non-locally (with `throw' or by
+signalling an error), this will result in loading all values into
+memory. If you just need to enumerate the keys, use
+`extmap-keys' instead."
+ (maphash (lambda (key _value) (funcall callback key (extmap-get extmap
key))) (nth 1 extmap)))
+
+(defun extmap-mapcar (extmap callback)
+ "Invoke CALLBACK on each key-value pairing in the map.
+Return its results as a list.
+
+Returned list corresponds to the order in which keys have been
+passed to CALLBACK. However, that order can be arbitrary.
+
+See `extmap-mapc' for more information."
+ (let (result)
+ (maphash (lambda (key _value) (push (funcall callback key (extmap-get
extmap key)) result)) (nth 1 extmap))
+ (nreverse result)))
+
+(defun extmap-statistics (extmap)
+ "Collect and return some statistics about EXTMAP.
+
+Returned value is an alist (in no particular order) with at least
+the following items:
+
+ `filename': absolute path of the file that contains the map;
+ `num-items': number of key-value mappings in the map;
+ `num-loaded': number of loaded values.
+
+In some cases maps can report loaded values right after
+initialization. This is because of value inlining and typically
+happens for small values. In case the map has been initialized
+with WEEK-DATA argument, `num-loaded' should be seen as an upper
+limit only, as (some) loaded values can be garbage-collected at
+any time."
+ (let ((items (nth 1 extmap))
+ (weak-data (nth 2 extmap))
+ (num-loaded 0))
+ (maphash (lambda (_key value) (when (car value) (setq num-loaded (1+
num-loaded)))) items)
+ `((filename . ,(nth 0 extmap))
+ (num-items . ,(hash-table-count items))
+ (num-loaded . ,(+ num-loaded (if weak-data (hash-table-count weak-data)
0))))))
+
+
+(defun extmap-from-alist (filename data &rest options)
+ "Create an externally-stored map from given DATA.
+
+Created map is stored to file specified by FILENAME. Later this
+filename should be passed to `extmap-init' to read the map.
+
+DATA must be an alist with symbols used as keys. All symbols
+must be interned in the default obarray. Values must be
+serializable with `print'/`read' (e.g. no buffers or non-interned
+symbols), but are otherwise not restricted.
+
+OPTIONS can be a list of the following keyword arguments:
+
+ :overwrite
+
+ By default, this function will signal an error if the output
+ file already exists. However, you can order it to
+ overwrite (not merge!) the file.
+
+ :max-inline-bytes
+
+ Inline values for which `print' results in this many bytes.
+ Inlined values are loaded by `extmap-init' immediately and
+ don't require additional disk access later. Default value is
+ currently 16, but can be changed in a future package version.
+ If this setting is important for you for some reason, always
+ specify it explicitly."
+ (apply #'extmap-from-iterator filename (funcall (iter-lambda () (while data
(iter-yield (pop data))))) options))
+
+(defun extmap-from-iterator (filename iterator &rest options)
+ "Create an externally-stored map from data provided by ITERATOR.
+Iterator must return cons cells with car being a symbol (key),
+cdr -- the value. See standard Emacs form `iter-defun' for how
+to declare iterator functions.
+
+See `extmap-from-alist' for more information. This function is
+basically the same, but is provided for the cases your values are
+so huge you'd rather provide them one-by-one with an iterator
+rather than keep them all in memory."
+ (with-temp-buffer
+ (let ((print-level nil)
+ (print-length nil)
+ (max-inline-bytes (or (plist-get options
:max-inline-bytes) 16))
+ (offset (bindat-length
extmap--header-bindat-spec nil))
+ (buffer (current-buffer))
+ (coding-system-for-write 'no-conversion)
+ (write-region-inhibit-fsync t)
+ (used-keys (make-hash-table :test #'eq)))
+ ;; Will be replaced at the end.
+ (insert (bindat-pack extmap--header-bindat-spec nil))
+ (write-region (point-min) (point-max) filename nil nil nil (if
(plist-get options :overwrite) nil 'excl))
+ (erase-buffer)
+ (iter-do (item iterator)
+ (let ((key (car item))
+ (value (cdr item)))
+ (unless (and (symbolp key) (not (string-match (rx 0) (symbol-name
key))) (eq (intern (symbol-name key)) key))
+ (error "Wrong key `%S': expected an interned symbol without null
character" key))
+ (when (gethash key used-keys)
+ (error "Duplicate key `%s'" key))
+ (puthash key t used-keys)
+ (insert (encode-coding-string (symbol-name key) 'utf-8 t))
+ (insert 0)
+ (with-temp-buffer
+ (let ((serialized (if (stringp value) value (prin1-to-string
value))))
+ (unless (or (stringp value) (condition-case _ (equal (read
serialized) value) (error nil)))
+ (error "Value for key `%s' cannot be saved in database: it
cannot be read back or is different after reading" key))
+ (insert (encode-coding-string serialized 'utf-8 t))
+ (let ((num-bytes (buffer-size)))
+ (if (<= num-bytes max-inline-bytes)
+ (let ((serialized-in (current-buffer)))
+ (with-current-buffer buffer
+ (insert (bindat-pack extmap--item-short-bindat-spec
`((type . ,(if (stringp value) 0 1)) (length . ,num-bytes))))
+ (insert-buffer-substring serialized-in)))
+ (write-region (point-min) (point-max) filename t)
+ (with-current-buffer buffer
+ (insert (bindat-pack extmap--item-bindat-spec `((type .
,(if (stringp value) 2 3)) (length . ,num-bytes) (offset . ,offset))))
+ (setq offset (+ offset num-bytes)))))))))
+ (write-region (point-min) (point-max) filename t)
+ ;; Update the header.
+ (erase-buffer)
+ (insert (bindat-pack extmap--header-bindat-spec `((magic . #x91f7)
+ (version . 0)
+ (num-items .
,(hash-table-count used-keys))
+ (offset .
,offset))))
+ (write-region (point-min) (point-max) filename 0))))
+
+
+(provide 'extmap)
+
+;;; extmap.el ends here
diff --git a/run-tests.sh b/run-tests.sh
new file mode 100755
index 0000000000..5bbae4e908
--- /dev/null
+++ b/run-tests.sh
@@ -0,0 +1,21 @@
+#! /usr/bin/env bash
+
+set -e
+
+if [ -z "$EMACS" ] ; then
+ EMACS=emacs
+fi
+
+if [ -z "$ERT_SELECTOR" ] ; then
+ ERT_SELECTOR=t
+fi
+
+$EMACS -batch \
+ --eval "(message \"Using Emacs %s\" (emacs-version))" \
+ -l extmap.el \
+ -l test/extmap-test.el \
+ --eval "(let ((ert-quiet t)) (ert-run-tests-batch-and-exit (quote
${ERT_SELECTOR})))"
+
+$EMACS -Q --batch \
+ --eval "(setq byte-compile-error-on-warn t)" \
+ --eval "(batch-byte-compile)" extmap.el
diff --git a/test/extmap-test.el b/test/extmap-test.el
new file mode 100644
index 0000000000..edbb660a67
--- /dev/null
+++ b/test/extmap-test.el
@@ -0,0 +1,52 @@
+;;; -*- lexical-binding: t -*-
+
+;;; Copyright (C) 2018 Paul Pogonyshev
+
+;; 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.
+
+
+(require 'extmap)
+(require 'ert)
+
+
+(defconst extmap--test-directory (file-name-directory (or load-file-name
(buffer-file-name))))
+
+(defvar extmap--test-filename nil)
+
+
+(defun extmap--test-alist (data &rest options)
+ (let ((filename (concat extmap--test-directory (or extmap--test-filename
"test.extmap"))))
+ (apply #'extmap-from-alist filename data :overwrite t options)
+ (let ((extmap (extmap-init filename)))
+ (should (equal (extmap--test-sort-keys (mapcar #'car data))
(extmap--test-sort-keys (extmap-keys extmap))))
+ (dolist (entry data)
+ (should (extmap-contains-key extmap (car entry)))
+ (should (equal (extmap-get extmap (car entry)) (cdr entry)))
+ (should (extmap-value-loaded extmap (car entry)))))))
+
+(defun extmap--test-sort-keys (keys)
+ (sort keys (lambda (a b) (string< (symbol-name a) (symbol-name b)))))
+
+
+(ert-deftest extmap-1 ()
+ (extmap--test-alist `((foo . 1)
+ (bar . "string")
+ (baz . ,(number-sequence 0 100))
+ (spam . "lalala lalala lalala lalala lalala lalala
lalala lalala lalala lalala lalala"))))
+
+(ert-deftest extmap-nonascii-1 ()
+ (extmap--test-alist `((раз . 1)
+ (два . "два")
+ (три . ,(cons "ноль" (number-sequence 1 100)))
+ (четыре . "В траве сидел кузнечик, // В траве сидел
кузнечик, // Совсем как огуречик, // Зелененький он был."))))
