diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..d41a940 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.gif filter=lfs diff=lfs merge=lfs -text diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENCE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.org b/README.org new file mode 100644 index 0000000..7a4acac --- /dev/null +++ b/README.org @@ -0,0 +1,26 @@ +#+TITLE: Emacs StarDict (CLI Version) Viewer +#+AUTHOR: tecosaur +#+DATE: July 29, 2020 + +It's nice to know more about the words you're using. Online dictionaries have +proliferated and become quite useful, and there are some nice packages available +like [[https://github.com/abo-abo/define-word][define-word]] which make use of such online resources. + +However, the quicker I can know more about the words I'm using, the better! +Offline dictionaries are obviously the way to go then, and the Console +implementation of StarDict already has a package or two for Emacs. + +I like things fancy though, and all of the existing StarDict interfaces seem a +bit ... restrained --- so I grabbed one of the existing ones and hacked away on it +for a bit. + +This has rich support for the following dictionaries: + + [[http://download.huzheng.org/dict.org/stardict-dictd-web1913-2.4.2.tar.bz2][Webster's Revised Unabridged Dictionary (1913)]] + + [[https://packages.debian.org/sid/dict-gcide][GCIDE]] (with conversion from dict to StarDict) + + [[http://download.huzheng.org/bigdict/stardict-Soule_s_Dictionary_of_English_Synonyms-2.4.2.tar.bz2][Soule's Dictionary of English Synonyms]] + + [[http://download.huzheng.org/dict.org/stardict-dictd_www.dict.org_elements-2.4.2.tar.bz2][Elements Database]] + + [[https://github.com/tuxor1337/dictmaster][Douglas Harper's Online Etymology Dictionary]] + +If you happen to use Doom, you may find [[https://tecosaur.github.io/emacs-config/config.html#stardict][this section]] of my config interesting. + +[[file:sdcv.gif]] diff --git a/sdcv.el b/sdcv.el index fe26c97..84c85f6 100644 --- a/sdcv.el +++ b/sdcv.el @@ -1,10 +1,12 @@ - ;;; sdcv-mode.el --- major mode to do dictionary query through sdcv +;;; sdcv.el --- major mode to do dictionary query through sdcv -*- lexical-binding: t; -*- ;; Copyright 2006~2008 pluskid, -;; 2011 gucong +;; 2011~2012 gucong +;; 2020 tecosaur ;; ;; Author: pluskid , -;; gucong +;; gucong , +;; tecosaur ;; ;; This program is free software; you can redistribute it and/or ;; modify it under the terms of the GNU General Public License as @@ -31,10 +33,40 @@ ;;; Changelog: +;; 2020/07/28 +;; * New variable: `sdcv-dictionary-specs', allows for +;; - Dictionary display names +;; - Custom dictionary entry formatters +;; - Dictionary sorting +;; * Update outline function calls to replace depreciated names.' +;; * Tweak sdcv-mode +;; - Remove font-locking +;; - Change `outline-regexp' to ZERO WIDTH SPACE +;; - Add `outline-heading-end-regexp', a PUNCTUATION SPACE +;; - Expand the mode map, to bind +;; - Two modes of entry navigation +;; - History navigation +;; - TAB for toggling an entry +;; * Expand popup window +;; * Add linear history navigation +;; * Revise behaviour of `sdcv-next-entry' and `sdcv-previous-entry' +;; * New function: `sdcv-get-outline-path' which gives the structural path +;; to the current position in buffer, e.g. dict → word v. t. → 1. (Chem.) +;; * Remove (now unused) custom face vars, could do with adding some +;; new face vars in the future +;; * Change the default of `sdcv-program-path' to be an absolute path +;; * New functions: `sdcv-format-result', `sdcv-failed-p', +;; and `sdcv-format-failure' to handle the upgraded entry prodessing +;; * New functions: `sdcv-format-webster', `sdcv-format-online-etym', +;; `sdcv-format-element', and `sdcv-format-soule' to format +;; the dictionaries recognised by default in `sdcv-dictionary-specs'. +;; - with helper functions `sdcv-format-webster-diacritics', and +;; `sdcv-format-expand-abbreviations' for nicer content. + ;; 2012/01/02 ;; * New variable: `sdcv-word-processor' ;; * Breaking change: -;; for `sdcv-dictionary-list' and `sdcv-dictionary-alist', +;; for `shttps://github.com/gucong/emacs-sdcv/blob/master/sdcv-mode.elhttps://github.com/gucong/emacs-sdcv/blob/master/sdcv-mode.eldcv-dictionary-list' and `sdcv-dictionary-alist', ;; non-list (non-nil) value now means full dictionary list ;; * Rewrite `sdcv-search' for both interactive and non-interactive use ;; * `sdcv-dictionary-list' is left for customization use only @@ -50,13 +82,13 @@ ;;; Code: (require 'outline) -(provide 'sdcv-mode) -(eval-when-compile - (require 'cl)) +(require 'dash) +(require 'cl) +(provide 'sdcv) ;;; ================================================================== ;;; Frontend, search word and display sdcv buffer -(defun sdcv-search (word &optional dict-list-name dict-list interactive-p) +(defun sdcv-search (word &optional dict-list-name dict-list interactive-p no-history-p) "Search WORD through the command-line tool sdcv. The result will be displayed in buffer named with `sdcv-buffer-name' with `sdcv-mode' if called interactively. @@ -110,14 +142,19 @@ Word may contain some special characters: (while (get-process sdcv-process-name) (sleep-for 0.01))) (let ((result - (concat ">>>" (mapconcat (lambda (w) (sdcv-do-lookup w)) (if sdcv-word-processor (let ((processed (funcall sdcv-word-processor word))) (if (listp processed) processed (list processed))) (list word)) - ">>>")))) + ""))) + (unless no-history-p + (setq sdcv--search-history + (append (subseq sdcv--search-history + 0 sdcv--search-history-position) + (list word)) + sdcv--search-history-position (length sdcv--search-history))) (if (not interactive-p) result (with-current-buffer (get-buffer-create sdcv-buffer-name) @@ -126,7 +163,24 @@ Word may contain some special characters: (insert result)) (sdcv-goto-sdcv) (sdcv-mode) - (sdcv-mode-reinit)))) + (sdcv-mode-reinit) + (let* ((window (get-buffer-window (sdcv-get-buffer))) + (height (window-height window)) + (min-height (pcase (count-lines (point-min) (point-max)) + ((pred (> 50)) 12) + ((pred (> 100)) 16) + (_ 20)))) + (when (> min-height height) + (window-resize window (- 12 height))))))) + +(defun sdcv-search-word-at-point () + (interactive) + (sdcv-search + (downcase + (or (and transient-mark-mode mark-active + (buffer-substring-no-properties + (region-beginning) (region-end))) + (current-word nil t))) nil nil t)) (defun sdcv-list-dictionary () "Show available dictionaries." @@ -146,6 +200,27 @@ and `sdcv-dictionary-path'." (list "-u" dict)) sdcv-current-dictionary-list)))) +(defvar sdcv--search-history nil) +(defvar sdcv--search-history-position 0) + +(defun sdcv-search-history-backwards () + (interactive) + (if (> sdcv--search-history-position 0) + (sdcv-search (nth (setq sdcv--search-history-position + (1- sdcv--search-history-position)) + sdcv--search-history) + nil nil t t) + (message "At start of search history."))) + +(defun sdcv-search-history-forwards () + (interactive) + (if (> (length sdcv--search-history) sdcv--search-history-position) + (sdcv-search (nth (setq sdcv--search-history-position + (1+ sdcv--search-history-position)) + sdcv--search-history) + nil nil t t) + (message "At end of search history."))) + ;;; ================================================================== ;;; utilities to switch from and to sdcv buffer (defvar sdcv-previous-window-conf nil @@ -161,6 +236,7 @@ and `sdcv-dictionary-path'." (if (null window) (switch-to-buffer-other-window buffer) (select-window window)))) + (defun sdcv-return-from-sdcv () "Bury sdcv buffer and restore the previous window configuration." (interactive) @@ -180,37 +256,31 @@ and `sdcv-dictionary-path'." buffer)) ;;; ================================================================== -;;; The very major mode -(defvar sdcv-mode-font-lock-keywords - '( - ;; dictionary name - ("^-->\\(.*\\)$" . (1 sdcv-hit-face)) - ("^==>\\(.*\\)$" . (1 sdcv-failed-face)) - ("^\\(>>>.*\\)$" . (1 sdcv-heading-face)) - ) - "Expressions to hilight in `sdcv-mode'") (defvar sdcv-mode-map (let ((map (make-sparse-keymap))) (define-key map "q" 'sdcv-return-from-sdcv) - (define-key map (kbd "RET") 'sdcv-search) - (define-key map "a" 'show-all) - (define-key map "h" 'hide-body) + (define-key map (kbd "RET") 'sdcv-search-word-at-point) + (define-key map "a" 'outline-show-all) + (define-key map "h" 'outline-hide-body) (define-key map "o" 'sdcv-toggle-entry) + (define-key map (kbd "TAB") 'sdcv-toggle-entry) (define-key map "n" 'sdcv-next-entry) + (define-key map "N" (lambda () (interactive) (sdcv-next-entry t))) (define-key map "p" 'sdcv-previous-entry) + (define-key map "P" (lambda () (interactive) (sdcv-previous-entry t))) + (define-key map "b" 'sdcv-search-history-backwards) + (define-key map "f" 'sdcv-search-history-forwards) map) "Keymap for `sdcv-mode'.") -(define-derived-mode sdcv-mode nil "sdcv" +(define-derived-mode sdcv-mode text-mode "sdcv" "Major mode to look up word through sdcv. \\{sdcv-mode-map} Turning on Text mode runs the normal hook `sdcv-mode-hook'." - (setq font-lock-defaults '(sdcv-mode-font-lock-keywords)) (setq buffer-read-only t) - (set (make-local-variable 'outline-regexp) "-->.*\n-->\\|==>\\|>>>") - (set (make-local-variable font-lock-string-face) nil) -) + (setq-local outline-regexp "\u200B+") + (setq-local outline-heading-end-regexp "\u2008")) (defun sdcv-mode-reinit () "Re-initialize buffer. @@ -220,10 +290,11 @@ the beginning of the buffer." (setq buffer-read-only nil) (sdcv-parse-failed) (setq buffer-read-only t) - (hide-body) + (when (< 30 (count-lines (point-min) (point-max))) + (outline-hide-sublevels 3)) (goto-char (point-min)) - (forward-line 1) - (show-entry))) + (search-forward "\u200B\u200B") + (left-char 1))) (defun sdcv-parse-failed () (goto-char (point-min)) @@ -236,37 +307,74 @@ the beginning of the buffer." (match-string 1) (insert (format "\n==>%s\n" save-word))))))) -(defun sdcv-next-entry () +(defun sdcv-expand-entry () + "Show the children of the current entry, or subtree if there are none." + (outline-show-children) + (when ; no children + (<= 0 (- (save-excursion (outline-next-heading) (point)) + (save-excursion (outline-end-of-subtree) (point)))) + (outline-show-subtree))) + +(defun sdcv-next-entry (&optional linear) + "Move to the next entry, targeting the same level unless LINEAR is set." (interactive) - (outline-next-heading) - (show-entry) - (recenter-top-bottom 0)) -(defun sdcv-previous-entry () + (when (< 1 (sdcv-outline-level)) + (outline-hide-subtree)) + (if linear + (outline-next-heading) + (condition-case nil + (outline-forward-same-level 1) + (error + (condition-case nil + (progn + (outline-up-heading 1 t) + (outline-forward-same-level 1)) + (error (progn (outline-next-heading) + (sdcv-expand-entry))))))) + (sdcv-expand-entry) + (recenter-top-bottom 1) + (message "%s" (sdcv-get-outline-path))) + +(defun sdcv-previous-entry (&optional linear) + "Move to the previous entry, targeting the same level unless LINEAR is set." (interactive) - (outline-previous-heading) - (show-entry) - (recenter-top-bottom 0)) + (outline-hide-subtree) + (if (= 2 (line-number-at-pos)) + (recenter-top-bottom -1) + (if linear + (outline-previous-heading) + (condition-case nil + (outline-backward-same-level 1) + (error + (condition-case nil + (outline-up-heading 1 t) + (error (outline-previous-heading)))))) + (sdcv-expand-entry) + (recenter-top-bottom 2)) + (message "%s" (sdcv-get-outline-path))) (defun sdcv-toggle-entry () (interactive) (save-excursion (outline-back-to-heading) - (if (not (outline-invisible-p (line-end-position))) - (hide-entry) - (show-entry)))) + (if (not (save-excursion + (outline-end-of-heading) + (outline-invisible-p (line-end-position)))) + (outline-hide-subtree) + (outline-show-subtree)))) ;;; ================================================================== ;;; Support for sdcv process in background -(defun sdcv-do-lookup (word) +(defun sdcv-do-lookup (word &optional raw-p) "Send the word to the sdcv process and return the result." (let ((process (sdcv-get-process))) (process-send-string process (concat word "\n")) (with-current-buffer (process-buffer process) - (let ((i 0) rlt done) + (let ((i 0) result done) (while (and (not done) (< i sdcv-wait-timeout)) (when (sdcv-match-tail sdcv-word-prompts) - (setq rlt (buffer-substring-no-properties (point-min) + (setq result (buffer-substring-no-properties (point-min) (point-max))) (setq done t)) (when (sdcv-match-tail sdcv-choice-prompts) @@ -279,7 +387,15 @@ the beginning of the buffer." (kill-process process) (error "ERROR: timeout waiting for sdcv")) (erase-buffer) - rlt)))) + (if raw-p result + (sdcv-format-result result)))))) + +(defun sdcv-oneshot-lookup (word &optional raw-p args) + (let ((result (shell-command-to-string + (concat sdcv-program-path " -n " args + " '" (replace-regexp-in-string "'" "\\'" word) "'")))) + (if raw-p result + (sdcv-format-result result)))) (defvar sdcv-wait-timeout 2 "The max time (in seconds) to wait for the sdcv process to @@ -291,20 +407,14 @@ sdcv's output.") (defconst sdcv-process-name "%sdcv-mode-process%") (defconst sdcv-process-buffer-name "*sdcv-mode-process*") -(defvar sdcv-word-prompts '("Enter word or phrase: " - "请输入单词或短语：" - "請輸入單字或片語：") +(defvar sdcv-word-prompts '("Enter word or phrase: ") "A list of prompts that sdcv use to prompt for word.") -(defvar sdcv-choice-prompts '("Your choice[-1 to abort]: " - "您的选择为：" - "您的選擇為：") +(defvar sdcv-choice-prompts '("Your choice[-1 to abort]: ") "A list of prompts that sdcv use to prompt for a choice of multiple candicates.") -(defvar sdcv-result-patterns '("^Found [0-9]+ items, similar to [*?/|]*\\(.+?\\)[*?]*\\." - "^发现 [0-9]+ 条记录和 [*?/|]*\\(.+?\\)[*?]* 相似。" - ) +(defvar sdcv-result-patterns '("^Found [0-9]+ items, similar to [*?/|]*\\(.+?\\)[*?]*\\.") "A list of patterns to extract result word of sdcv. Special characters are stripped.") @@ -313,25 +423,25 @@ characters are stripped.") (let ((process (get-process sdcv-process-name))) (when (null process) (with-current-buffer (get-buffer-create - sdcv-process-buffer-name) - (erase-buffer) - (setq process (apply 'start-process - sdcv-process-name - sdcv-process-buffer-name - sdcv-program-path - (sdcv-generate-dictionary-argument))) - ;; kill the initial prompt - (let ((i 0)) - (message "starting sdcv...") - (while (and (not (sdcv-match-tail sdcv-word-prompts)) - (< i sdcv-wait-timeout)) - (sleep-for sdcv-wait-interval) - (setq i (+ i sdcv-wait-interval))) - (unless (< i sdcv-wait-timeout) - ;; timeout - (kill-process process) - (error "ERROR: timeout waiting for sdcv")) - (erase-buffer)))) + sdcv-process-buffer-name) + (erase-buffer) + (setq process (apply 'start-process + sdcv-process-name + sdcv-process-buffer-name + sdcv-program-path + (sdcv-generate-dictionary-argument))) + ;; kill the initial prompt + (let ((i 0)) + (message "starting sdcv...") + (while (and (not (sdcv-match-tail sdcv-word-prompts)) + (< i sdcv-wait-timeout)) + (sit-for sdcv-wait-interval t) + (setq i (+ i sdcv-wait-interval))) + (unless (< i sdcv-wait-timeout) + ;; timeout + (kill-process process) + (error "ERROR: timeout waiting for sdcv")) + (erase-buffer)))) process)) (defun sdcv-buffer-tail (length) @@ -357,6 +467,1331 @@ current buffer." (setq done t))) done)) +;;;;################################################################## +;;;; Output Processing +;;;;################################################################## + +(defun sdcv-format-result (result) + "For a given RESULT from sdcv, test for failure and format accordingly. +Entries are sorted by their :priority in `sdcv-dictionary-specs', and formatted by +`sdcv-format-result' in the case of success; `sdcv-format-failure' otherwise." + + (if (sdcv-failed-p result) + (sdcv-format-failure result) + + (let* ((entries + (sort (sdcv-parse-results result) + (lambda (a b) + (< (or (sdcv-dictionary-spec (plist-get a :dict) :priority) 1) + (or (sdcv-dictionary-spec (plist-get b :dict) :priority) 1))))) + (word (save-match-data + (string-match "\\`Found.* similar to \\(\\w+\\)\\." result) + (downcase (match-string 1 result))))) + (concat + "\u200B" + (propertize (capitalize word) 'face 'outline-1) + "\u2008" + (apply #'concat + (mapcar (lambda (e) + (sdcv-format-entry + e word)) + entries)))))) + +(defun sdcv-parse-results (result) + "TODO" + (let (entries latest-match last-match dict word) + (with-temp-buffer + (insert result) + (goto-char (point-min)) + (while + (setq latest-match (re-search-forward + "-->\\([^\n]+\\)\n-->\\(.+\\)\n\n" nil t)) + (when last-match + (forward-line -3) + (setq entries + (append entries + `((:word ,word + :dict ,dict + :info ,(buffer-substring last-match (point)))))) + (forward-line 3)) + (setq last-match latest-match) + (setq dict (match-string 1)) + (setq word (match-string 2))) + (when last-match + (setq entries + (append entries + `((:word ,word + :dict ,dict + :info ,(buffer-substring last-match (point-max))))))))) + ) + +(defun sdcv-failed-p (results) + "Whether the RESULTS match the hardcoded failure pattern." + (if (string-match-p "Found [0-9]+ items, similar to [^.]+\\.\n0)" results) t nil)) + +(defun sdcv-format-failure (results) + "When sdcv failed to match the word, format the suggestions in RESULTS." + (let (suggestions last-match) + (while (setq last-match + (string-match "^[0-9]+)\\(.*\\)-->\\([A-Za-z]+\\)" + results + (when last-match (1+ last-match)))) + (let ((dict (match-string 1 results)) + (word (match-string 2 results))) + (if (assoc dict suggestions) + (setcdr (assoc dict suggestions) + (list (append (cadr (assoc dict suggestions)) (list word)))) + (setq suggestions (append suggestions `((,dict . ((,word))))))))) + (concat + (propertize + (replace-regexp-in-string + "items" "entries" + (substring results 0 (string-match "\n" results))) + 'face 'warning) + "\n" + (mapconcat (lambda (dict-suggestions) + (format "\u200B\u200B%s\n\u200B\u200B\u200B%s" + (propertize (or + (sdcv-dictionary-spec (car dict-suggestions) :short) + (car dict-suggestions)) + 'face 'outline-3) + (propertize (s-join "\n\u200B\u200B\u200B" + (cadr dict-suggestions)) + 'face 'font-lock-keyword-face))) + (sort suggestions + (lambda (a b) + (< (or (sdcv-dictionary-spec (car a) :priority) 1) + (or (sdcv-dictionary-spec (car b) :priority) 1)))) + "\n")))) + +(defun sdcv-format-entry (entry &optional expected-word) + "Format a given ENTRY, a plist with :word :dict and :info. +If the DICT has a :short value in `sdcv-dictionary-specs' that is used as +the display name. Likewise if present, :formatter is used to generate the +entry." + (let ((dict (plist-get entry :dict))) + (concat + "\n\u200B\u200B" + (propertize (or (sdcv-dictionary-spec dict :short) + dict) 'face 'outline-3) + "\n\u2008\n" + (if-let* ((formatter (sdcv-dictionary-spec dict :formatter))) + (let ((case-fold-search nil)) + (string-trim (funcall formatter entry expected-word))) + entry) + "\n"))) + +(defun sdcv-get-outline-path () + "Return a string giving the structural path to the current position." + (let ((outline-path "") + (last-pos 0) + outline-level-current substring level-regexp) + (save-excursion + (outline-back-to-heading) + (setq outline-level-current (sdcv-outline-level)) + (while (/= (point) last-pos) + (setq outline-level-current (sdcv-outline-level)) + (setq substring + (buffer-substring + (point) + (save-excursion (search-forward "\u2008") (point)))) + (setq level-regexp + (case outline-level-current + (1 "^\\([^\n]+\\)") + (2 "^\\([^ \n]+\\)") + (3 "^\u200B\u200B*\\([^,]+\\(?:, [ &.;a-z]+\\)?\\)") + (4 "\\([0-9]+\\.\\( ?([^)]+)\\)?\\( \\w+\\)\\{0,4\\}\\)") + (5 "\\(([a-z])\\( ?([^)]+)\\)?\\( \\w+\\)\\{0,4\\}\\)") + (t "^\u200B\u200B*\\([^ ]+\\)"))) + (setq outline-path + (concat + (propertize " → " 'face 'bold) + (save-match-data + (string-match level-regexp substring) + (match-string 1 substring)) + outline-path)) + (setq last-pos (point)) + (ignore-errors + (outline-up-heading 1))) + (substring outline-path 2)))) + +(defun sdcv-outline-level () + "It seems that while (outline-level) should work, it has issues." + (- (save-excursion (outline-back-to-heading) + (search-forward-regexp "\u200B+")) + (point))) + +(defun sdcv-dictionary-spec (dict spec) + "Helper function to get a :SPEC of a given DICT." + (plist-get (cdr (assoc dict sdcv-dictionary-specs)) spec)) + +(defvar sdcv-dictionary-specs + '(("Webster's Revised Unabridged Dictionary (1913)" + :formatter sdcv-format-webster + :priority 1) + ("Elements database" + :short "Element" + :formatter sdcv-format-element + :priority 2) + ("Hitchcock's Bible Names Dictionary" + :short "Hitcchcock's Bible Names" + :priority 3) + ("Online Etymology Dictionary" + :short "Etymology" + :formatter sdcv-format-online-etym + :priority 4) + ("Soule's Dictionary of English Synonyms" + :short "Synonyms" + :formatter sdcv-format-soule + :priority 5)) + "Alist of dictionary information, where the car is the name +according to sdcv, and the cdr is a plist whith the following options: + :short - a (usually) shorter display name for the dictionary + :formatter - a function with signature (ENTRY WORD) that returns a string + :priority - sort priority, defaults to 1") + +(defun sdcv-format-webster (entry &optional expected-word) + "Make a Webster's dictionary ENTRY for WORD look nice. +Designed for Webster's Revised Unabridged Dictionary (1913), +as found at http://download.huzheng.org/dict.org/stardict-dictd-web1913-2.4.2.tar.bz2. + +This should also work nicely with GCIDE." + (->> (plist-get entry :info) + (sdcv-format-webster-diacritics) + (replace-regexp-in-string ; entry dividors + (format "\n\n\\(%s\\)" (plist-get entry :word)) + "\n ━━━━━━━━━ ■ ━━━━━━━━━\n\n\\1") + (replace-regexp-in-string ; entry headline + (rx line-start + (group-n 1 ; word + (any "A-Z") + (+ (any "a-z"))) + (optional " \\" ; word2 + (group-n 2 (+ (not (any "\\")))) + "\\") + (optional " (" ; pronounciation + (group-n 3 (+ (not (any ")")))) + ")") + ", " + (group-n 4 ; part of speech + (+ (any "A-Z" "a-z" ".;&" " "))) + (optional "[" ; etymology / alternative forms + (group-n 5 + (+ (or (+ (not (any "]["))) + (and "[" (+ (not (any "]["))) "]")))) + "]") + (optional ; definately etymology + (+ (any "\n" " ")) "[" + (group-n 6 + (+ (or (+ (not (any "]["))) + (and "[" (+ (not (any "]["))) "]")))) + "]") + (optional " (" ; category + (group-n 7 (+ (not (any ")")))) + ")")) + (lambda (match) + (let* ((word2 (match-string 2 match)) + (pronounciation (match-string 3 match)) + (part-of-speech (sdcv-format-expand-abbreviations + (replace-regexp-in-string " \\'" "" + (match-string 4 match)))) + (alternative-forms (when (match-string 6 match) + (sdcv-format-expand-abbreviations (match-string 5 match)))) + (etymology (sdcv-format-expand-abbreviations (match-string (if alternative-forms 6 5) match))) + (category (sdcv-format-expand-abbreviations (match-string 7 match))) + (last-newline (lambda (text) (- (length text) + (or (save-match-data + (string-match "\n[^\n]*\\'" text)) 0))))) + (concat + "\u200B\u200B\u200B" + (propertize word2 + 'face 'bold) + (when pronounciation + (propertize (format " %s" pronounciation) + 'face 'font-lock-type-face)) + ", " + (propertize part-of-speech + 'face '(bold font-lock-keyword-face)) + (when alternative-forms + (setq alternative-forms + (sdcv-format-reflow-text + (format " [%s]" alternative-forms) + 80 10 + (+ 3 (if pronounciation 1 0) + (funcall last-newline + (concat word2 pronounciation part-of-speech))) + " ")) + (propertize alternative-forms + 'face 'diff-context)) + (when etymology + (setq etymology + (sdcv-format-reflow-text + (format " [%s]" etymology) + 80 10 + (+ 3 (if pronounciation 1 0) + (funcall last-newline + (concat word2 pronounciation part-of-speech alternative-forms))) + " ")) + (propertize etymology + 'face 'font-lock-comment-face)) + (when category + (propertize (format " (%s)" category) + 'face 'font-lock-constant-face)) + "\u2008")))) + (replace-regexp-in-string ; categorised terms + "{\\([^}]+?\\)}\\(.?\\) (\\([^)]+?\\))" + (lambda (match) + (let ((term (match-string 1 match)) + (punct (match-string 2 match)) + (category (match-string 3 match))) + (concat + (propertize term 'face 'font-lock-keyword-face) + punct + (propertize (format " (%s)" + (if sdcv-expand-abbreviations + (sdcv-format-expand-abbreviations category) + category)) + 'face 'font-lock-constant-face))))) + (replace-regexp-in-string ; other terms + "{\\([^}]+?\\)}" + (lambda (match) + (let ((term (match-string 1 match))) + (concat + (propertize term 'face 'font-lock-keyword-face))))) + (replace-regexp-in-string ; quotations + "^\n +\\(\\w[[:ascii:]]+?\\)\\(\n? *--[A-Za-z0-9. ]+\n? *[A-Za-z0-9. ]*\\)" + (lambda (match) + (let ((body (match-string 1 match)) + (author (match-string 2 match))) + (concat + "\n " + (propertize (format "❝%s❞" body) + 'face 'font-lock-doc-face) + author "\n")))) + (replace-regexp-in-string ; attributions + " --\\([A-Z][A-Za-z. ]+\n? *[A-Za-z0-9. ]*\\)" + (lambda (match) + (propertize (concat " ──" (match-string 1 match)) + 'face '(italic font-lock-type-face)))) + (replace-regexp-in-string ; inline quotations (1) + "``" "“") + (replace-regexp-in-string ; inline quotations (1) + "''" "”") + (replace-regexp-in-string ; em dash approximation + " -- " " ─── ") + (replace-regexp-in-string ; lists + " \\(?:\\([0-9]+\\.\\)\\|\\( ([a-z])\\)\\) \\(?: ?(\\([^)]+\\)) \\)?\\(.*\\)" + (lambda (match) + (let ((number (match-string 1 match)) + (letter (match-string 2 match)) + (category (match-string 3 match)) + (rest-of-line (match-string 4 match))) + (concat + (when letter "\u200B") + "\u200B\u200B\u200B\u200B " + (when number + (propertize number 'face '(bold font-lock-string-face))) + (when letter + (propertize letter 'face 'font-lock-string-face)) + (when category + (propertize (format " (%s)" + (if sdcv-expand-abbreviations + (sdcv-format-expand-abbreviations category) + category)) + 'face 'font-lock-constant-face)) + " " + rest-of-line + "\u2008")))) + (replace-regexp-in-string ; note + " Note: " + (concat " " + (propertize " " 'display '(space . (:width 0.55))) + (propertize "☞" 'face 'font-lock-function-name-face) + " ")) + (replace-regexp-in-string ; subheadings + " \\(\\w+\\): " + (lambda (match) + (propertize (concat " "(match-string 1 match) ": ") + 'face 'bold))))) + +(defvar sdcv-expand-abbreviations t + "Whether or not to try to expand abbreviations, where they are expected.") + +(defun sdcv-format-expand-abbreviations (content &optional force) + (when content + (when (or sdcv-expand-abbreviations force) + (let ((abbreviations + '(; A + ("adj" "adjective") + ("a" "adjective") + ("abbrev" "abbreviated") + ("abl" "ablative") + ("Abp" "Archbishop") + ("acc" "Acoustics") + ("act" "active") + ("adv" "adverb") + ("Agric" "Agriculture") + ("Alban" "Albanian") + ("Alg" "Algebra") + ("Am" "America") + ("Amer" "American") + ("Am" "Amos") + ("Am\\. Cyc" "Appleton's American Cyclopedia") + ("Anal. Geom" "Analytical Geometry") + ("Anat" "Anatomy") + ("Anc" "Ancient") + ("Angl\\. Ch" "Anglican Church") + ("aor" "aorist") + ("Ar" "Arabic") + ("Arch" "Architecture") + ("Arch\\. Pub\\. Soc" "Architectural Pub. Society") + ("Arith" "Arithmetic") + ("Arm\\., Armor" "Armorican") + ("AS" "Anglo-Saxon") + ("Astrol" "Astrology") + ("Astron" "Astronomy") + ("aug" "augmentative") + ;; B + ("Bank" "Banking") + ("Beau\\. & Fl" "Beaumont & Fletcher") + ("B\\. & Fl" "Beaumont & Fletcher") + ("Bib\\. Sacra" "Bibliotheca Sacra") + ("Bib" "Biblical") + ("Bibliog" "Bibliography") + ("Biol" "Biology") + ("Bisc" "Biscayan") + ("B\\. Jon" "Ben Jonson") + ("Bk\\. of Com\\. Prayer " "Book of Common Prayer") + ("Blackw\\. Mag" "Blackwood's Magazine") + ("Bohem" "Bohemian") + ("Bot" "Botany") + ("Bp" "Bishop") + ("Brande & C" "Brande & Cox") + ("Braz" "Brazilian") + ("Brit\\. Critic" "British Critic") + ("Brit\\. Quar\\. Rev" "British Quarterly Review") + ("Burl" "Burlesque") + ;; C + ("C" "Centigrade") + ("Cant" "Canticles") + ("Carp" "Carpentry") + ("Catal" "Catalan") + ("Cath\\. Dict" "Catholic Dictionary") + ("Celt" "Celtic") + ("cf" "confer") + ("Ch" "Church") + ("Chald" "Chaldee") + ("Chem" "Chemistry") + ("Ch\\. Hist" "Church History") + ("Chron" "Chronology, Chronicles") + ("Civ" "Civil") + ("Class" "Classical") + ("Class\\. Myth" "Classical Mythology") + ("Col" "Colossians") + ("colloq\\., coll" "colloquial, colloquially") + ("Com" "Commerce, Common") + ("comp" "compound, compounded, composition") + ("compar" "comparative") + ("conj" "conjunction") + ("Con\\. Sect" "Conic Sections") + ("contr" "contracted, contraction") + ("Copt" "Coptic") + ("Corn" "Cornish") + ("corrupt" "corrupted, corruption") + ("Cotgr" "Cotgrave") + ("Cyc\\. Med" "Cyclopedia of Practical Medicine") + ("Crim\\. Law" "Criminal Law") + ("Crystallog" "Crystallography") + ("Cyc" "Cyclopedia") + ;; D + ("D" "Dutch (sometimes Daniel)") + ("Dan" "Danish") + ("dat" "dative") + ("def" "definitions") + ("Deut" "Deuteronomy") + ("Dial" "Dialectic") + ("dim" "diminutive") + ("Diosc" "dioscorides") + ("Disp" "Dispensatory") + ("Disus" "Disused") + ("Dom\\. Econ" "Domestic Economy") + ("Dublin Univ\\. Mag" "Dublin University Magazine") + ("Dyn" "Dynamics") + ;; E + ("E" "English") + ("Eccl" "Ecclesiastical, Ecclesiastes") + ("Eccl\\. Hist" "Ecclesiastical History") + ("Ecclus" "Ecclesiasticus") + ("Eclec\\. Rev" "Eclectic Review") + ("Ed\\. Rev" "Edinburgh Review") + ;; ("e\\. g" "exempli gratia (for example)") + ("Egypt" "Egyptian") + ("Elect" "Electricity") + ("Elec" "Electrical") + ("emph" "emphatic") + ("Encyc\\. Amer" "Encyclopedia Americana") + ("Encyc\\. Crit" "Encyclopedia Britannica") + ("Encyc\\. Dict" "Hunter's Encyclopedic Dictionary") + ("Encyc" "Encyclopedia") + ("Eng\\. Cyc" "English Cyclopedia") + ("Eng" "English") + ("Engin" "Engineering") + ("Eol" "Eolic") + ("Eph\\., Ephes" "Ephesians") + ("equiv" "equivalent") + ("Esd" "Esdras") + ("esp" "especially") + ("Etch\\. & Eng" "Etching & Engraving") + ("Ethnol" "Ethnology") + ("etym\\., etymol" "etymology") + ("Ex\\., Exod" "Exodus") + ("Ezek" "Ezekiel") + ;; F + ("F" "French") + ("f" "feminine") + ("fem" "feminine") + ("Fahr" "Fahrenheit") + ("Far" "Farriery") + ("Feud" "Feudal") + ("Fig" "Figurative, figuratively") + ("Fin" "Finnish") + ("For\\. Quart\\. Rev" "Foreign Quarterly Review") + ("Fort" "Fortification") + ("Fr" "French") + ("fr" "from") + ("freq" "frequentative") + ("Fries" "Friesic") + ("fut" "future") + ;; G + ("G" "German") + ("Gael" "Gaelic") + ("Gal" "Galen") + ("Gal" "Galatians") + ("Galv" "Galvanism") + ("gen" "generally, genitive") + ("Geneal" "Genealogy") + ("Gent\\. Mag" "Gentleman's Magazine") + ("Geog" "Geography") + ("Geol" "Geology") + ("Geom" "Geometry") + ("Ger" "Germanic or German") + ("Gk" "Greek") + ("Goth" "Gothic") + ("Gov\\. of Tongue" "Government of the Tongue") + ("Gr" "Greek") + ("Gram" "Grammar") + ("Gris" "Grisons") + ("Gun" "Gunnery") + ;; H + ("H" "High") + ("Hab" "Habakkuk") + ("Hag" "Haggai") + ("Ham\\. Nav\\. Encyc" "Hamersly's Naval Encyclopedia") + ("Heb" "Hebrew") + ("Her" "Heraldry") + ("Hind" "Hindostanee") + ("Hipp" "Hippocrates") + ("Hist" "History") + ("Horol" "Horology") + ("Hort" "Horticulture") + ("Hung" "Hungarian") + ("Hydraul" "Hydraulics") + ("Hydros" "Hydrostatics") + ("hypoth" "hypothetical") + ;; I + ("Icel" "Icelandic") + ;; ("i\\. e" "id est (that is)") + ("Illust" "Illustration, Illustrated") + ("imp" "imperfect") + ("Imp\\. Dict" "Imperial Dictionary") + ("incho" "inchoative") + ("ind" "indicative") + ("indef" "indefinite") + ("inf" "infinitive") + ("intens" "intensive") + ("interj" "interjection") + ("Internat\\. Cyc" "International Cyclopeia") + ("Ion" "Ionic") + ("i\\. q" "idem quod") + ("Ir" "Irish") + ("Is" "Isaiah") + ("Isa" "Isaiah") + ("It" "Italian") + ;; J + ("Jap" "Japanese") + ("Jas" "James") + ("Jav" "Javanese") + ("Jer" "Jeremiah") + ("Join" "Joinery") + ("Josh" "Joshua") + ("Judg" "Judges") + ;; K + ("K" "Kings") + ;; L + ("L" "Latin") + ("Lam" "Lamentations") + ("Lapp" "Lappish") + ("Lat" "Latin") + ("LD" "Low Dutch") + ("Lett" "Lettish") + ("Lev" "Leviticus") + ("LG" "Low German") + ("LGr" "Low Greek") + ("Linn" "Linnæus") + ("Lit" "Literally") + ("lit" "literally") + ("Lit" "Literature") + ("Lith" "Lithuanian") + ("LL" "Late Latin") + ;; M + ("M" "Middle") + ("m" "masculine") + ("masc" "masculine") + ("Maced" "Macedonian") + ("Mach" "Machinery") + ("Mad" "Madam") + ("Mag" "Magazine") + ("Mal" "Malachi") + ("Malay" "Malayan") + ("Man" "Manège") + ("Manuf" "Manufacturing") + ("Mar" "Maritime") + ("Math" "Mathematics") + ("Matt" "Matthew") + ("ME" "Middle English") + ("Mech" "Mechanic") + ("Med" "Medicine") + ("Metal" "Metallurgy") + ("Metaph" "Metaphysics") + ("Meteor" "Meteorolgy") + ("mgr" "milligrams") + ("MHG" "Middle High German") + ("Micros" "Microscopy") + ("Mil" "Military") + ("Min" "Mineralogy") + ("Mir\\. for Mag" "Mirror for Magistrates") + ("MLG" "Middle Low German") + ("Moham" "Mohammedan") + ("Mozley & W" "Mozley & Whiteley") + ("Mus" "Music") + ("Myst" "Mysteries") + ("Myth" "Mythology") + ;; N + ("Nat\\. Hist" "Natural History") + ("Nat\\. ord" "Natural order") + ("Naut" "Nautical") + ("Nav" "Navy") + ("Navig" "Navigation") + ("N\\. Brit\\. Rev" "North British Review") + ("Neh" "Nehemiah") + ("neut" "neuter") + ("New Am\\. Cyc" "New American Cyclopedia") + ("New Month\\. Mag" "New Monthly Magazine") + ("NF" "New French") + ("NGr" "Mew Greek") + ("NHeb" "New Hebrew") + ("NL" "New Latin") + ("nom" "nominative") + ("Norm\\. F" "Norman French") + ("North Am\\. Rev" "North American Review") + ("Norw" "Norwegian") + ("Num" "Numbers") + ("Numis" "Numismatics") + ("N" "New") + ;; O + ("O" "Old") + ("Ob" "Obadiah") + ("obs" "obsolete") + ("Obsoles" "Obsolescent") + ("OCelt" "Old Celtic") + ("OD" "Old Dutch") + ("ODan" "Old Danish") + ("OE" "Old English") + ("OF" "Old French") + ("OFelm" "Old Flemish") + ("OFris" "Old Frisian") + ("OFries" "Old Friesic") + ("OGael" "Old Gaelic") + ("OGr" "Old Greek") + ("OHG" "Old High German") + ("OIcel" "Old Icelandic") + ("OIt" "Old Italian") + ("OL" "Old Latin") + ("OIr" "Old Irish") + ("ON" "Old Norse") + ("OLG" "Old Low German") + ("OPer" "Old Persian") + ("OPg" "Old Portuguese") + ("OPol" "Old Polish") + ("Opt" "Optics") + ("orig" "original") + ("Ornith" "Ornithology") + ("OS" "Old Saxon") + ("OSlav" "Old Slavic") + ("OSp" "Old Spanish") + ("Oxf\\. Gloss" "Oxford Glossary of Architecture") + ;; P + ("p\\.[\n ]*a" "participial adjective") + ("Paint" "Painting") + ("Paleon" "Paleontology") + ("pass" "passive") + ("Pathol" "Pathology") + ("P\\. Cyc" "Penny Cyclopedia") + ("Per" "Persian") + ("perh" "perhaps") + ("pers" "person") + ("Persp" "Perspective") + ("Pert" "Pertaining") + ("Peruv" "Peruvian") + ("Pet" "Peter") + ("Pg" "Portuguese") + ("Pharm" "Pharmacy, Pharmacopœia") + ("Phil" "Phillipians") + ("Philem" "Philemon") + ("Philol" "Philology") + ("Philos" "Philosophy") + ("Phon" "Phonetics") + ("Photog" "Photography") + ("Photom" "Photometry") + ("Phren" "Phrenology") + ("Phys" "Physics") + ("Phys\\. Sci" "Physical Science") + ("Physiol" "Physiology") + ("pl" "plural") + ("Poet" "Poetry, Poetical") + ("Pol" "Polish") + ("Pol\\. Econ" "Political Economy") + ("Polit\\. Econ" "Political Economy") + ("Pop\\. Sci\\. Monthly" "Polular Science Monthly") + ("Poss" "Possessive") + ("pp" "pages") + ("P\\. Plowman" "Piers Plowman") + ("p\\.[\n ]*p" "past participle") + ("p\\.[\n ]*pr" "present participle") + ("p\\.[\n ]*ple" "present participle") + ("Pr" "Provençal") + ("Pref" "Preface") + ("pref" "prefix") + ("prep" "preposition") + ("pres" "present") + ("pret" "preterit") + ("prin" "principally") + ("Print" "Printing") + ("priv" "privative") + ("prob" "probably") + ("pron" "pronoun") + ("prop" "properly") + ("Pros" "Prosody") + ("prov" "provincial") + ("Prov" "Provincial") + ("Prov" "Proverbs") + ("Ps\\., Psa" "Psalms") + ("Pyro\\.-elect" "Pyro-electricity") + ("p" "participle") + ;; Q + ("Quart\\. Rev" "Quarterly Review") + ("q\\. v" "quod vide (which see)") + ;; R + ("R\\. C" "Roman Catholic") + ("R\\. C\\. Ch" "Roman Catholic Church") + ("Rep\\. Sec\\. of War" "Report of Secretary of War") + ("Rev" "Revelation") + ("Rev" "Review") + ("Rev\\. Ver" "Revised Version (of the Bible)") + ("Rhet" "Rhetoric") + ("R\\. of Brunne" "Robert of Brunne") + ("R\\. of Gl" "Robert of Gloucester") + ("Rom" "Roman, Romans") + ("Rom\\. Cath" "Roman Catholic") + ("Rom\\. of R" "Romaunt of the Rose") + ("Rpts" "reports") + ("Russ" "Russian") + ("R" "Rare") + ;; S + ("Sam" "Samaritan") + ("Sam" "Samuel") + ("Sat\\. Rev" "Saturday Review") + ("Sax" "Saxon") + ("sc" "scilicet (being understood)") + ("Scand" "Scandinavian") + ("Sci" "Science") + ("Sci\\. Am" "Scientific American") + ("Scot" "Scotland, Scottish") + ("Script" "Scripture, Scriptural") + ("Sculp" "Sculpture") + ("Serb" "Serbian") + ("Serv" "Servian") + ("Shak" "Shakespeare") + ("sing" "singular") + ("Skr" "Sanskrit") + ("Slav" "Slavonic") + ("Sp" "Spanish") + ("Specif" "Specifically") + ("Stat" "Statuary") + ("subj" "subjunctive") + ("superl" "superlative") + ("Surg" "Surgery") + ("Surv" "Surveying") + ("Sw" "Swedish") + ("Syd\\. Soc\\. Lex" "Sydenham Society Lexicon") + ("Syn" "Synonyms") + ("Synop" "Synopsis") + ("Syr" "Syriac") + ;; T + ("Tart" "Tartaric") + ("Teleg" "Telegraphy") + ("term" "termination") + ("Test" "Testament") + ("Theol" "Theology") + ("Thes" "Thessalonians") + ("Tim" "Timothy") + ("Todd & B" "Todd & Bowman") + ("Trans" "Translation") + ("Treas" "Treasury") + ("Trig" "Trigonometry") + ("Turk" "Turkish") + ("Typog" "Typography") + ;; U + ("Univ" "University") + ("Up" "Upper") + ("U\\. ?S" "United States") + ("U\\. ?S\\. Disp" "United States Dispensatory") + ("U\\. ?S\\. Pharm" "United States Pharmacopœia") + ("U\\. ?S\\. Int\\. Rev\\. Statutes" "United States Internal Revenue Statutes") + ("usu" "usually") + ;; V + ("v\\.[\n ]*i" "intransitive verb") + ("v\\.[\n ]*t" "transitive verb") + ("var" "variety") + ("vb\\.[\n ]*n" "verbal noun") + ("Veter" "Veterinary") + ("Vitr" "Vitruvius") + ;; W + ("W" "Welsh") + ("Wall" "Wallachian") + ("Westm\\. Cat" "Westminster Catechism") + ("Westm\\. Rev" "Westminster Review") + ;; Z + ("Zech" "Zechariah") + ("Zeph" "Zephaniah") + ("Zoöl" "Zoölogy") + ;; Reordered for correctness + ("n" "noun") + ("v" "verb") + ))) + (dolist (abbrev abbreviations) + (setq content + (replace-regexp-in-string + (concat "\\b" (car abbrev) "\\.") + (cadr abbrev) + content t))))) + content)) + +(defun sdcv-format-webster-diacritics (pronunciation) + (let ((diacritics + '(("[,C]" "Ç") + ("\"u" "ü") ; uum + ("'e" "é") ; eacute + ("\\^a" "â") ; acir + ("\"a" "ä") ; aum + ("`a" "à") ; agrave + ("\\*a" "å") ; aring + ("\\*u" "ů") ; uring + (",c" "ç") ; ccedil + ("cced" "ç") + ("\\^e" "ê") ; ecir + ("\"e" "ë") ; eum + ("`e" "è") ; egrave + ("\"i" "ï") ; ium + ("\\^i" "î") ; icir + ("`i" "ì") ; igrave + ("\"A" "Ä") ; Aum + ("\\*A" "Å") ; Aring + ("'E" "È") ; Eacute + ("ae" "æ") ; ae + ("AE" "Æ") ; AE + ("\\^o" "ô") ; ocir + ("\"o" "ö") ; oum + ("`o" "ò") ; ograve + ("'o" "ó") ; oacute + ("Oacute" "Ó") + ("\\^u" "û") ; ucir + ("`u" "ù") ; ugrave + ("'u" "ú") ; uacute + ("\"y" "ÿ") ; yum + ("\"O" "Ö") ; Oum + ("\"U" "Ü") + ("pound" "£") + ("'a" "á") ; aacute + ("'i" "í") ; iacute + ("frac23" "⅔") + ("frac13" "⅓") + ("frac12" "½") + ("frac14" "¼") + ("\\?" "�") ; Place-holder for unknown or illegible character. + ("hand" "☞") ; pointing hand (printer's u"fist") ; hand ; and + ("\\.\\.\\." "…") + ("\\*\\*\\*\\*\\*\\*\\*\\*" "✶") + ("sect" "§") ; sect + ("=a" "ā") ; amac + ("ng" "ṉ") ; u"n sub-macron" ; nsm + ("sharp" "♯") ; sharp + ("flat" "♭") ; flat + ("th" "th") ; th + ("=i" "ī") ; imac + ("imac" "ī") ; imac + ("=e" "ē") ; emac + ("\\.d" "ḍ") ; Sanskrit/Tamil d dot + ("\\.n" "ṇ") ; Sanskrit/Tamil n dot ; nsdot + ("\\.t" "ṭ") ; Sanskrit/Tamil t dot ; tsdot + ("a\\^" "ă") ; acr + ("e\\^" "ĕ") ; ecr + ("i\\^" "ĭ") ; icr + ("o\\^" "ŏ") ; ocr + ("!o" "ǒ") + ("OE" "Œ") ; OE + ("oe" "œ") ; oe + ("=O" "Ō") ; Omac + ("=o" "ō") ; omac + ("=u" "ū") ; umac + ("ocar" "ǒ") ; o hacek + ("=ae" "ǣ") ; aemac + ("u\\^" "ŭ") ; ucr + ("a\\^" "ă") + ("=y" "ȳ") ; ymac + ("asl" "a") ; FIXME: a u"semilong" (has a macron above with a short + ("-e" "e") ; FIXME: e u"semilong" ; esl + ("-i" "i") ; FIXME: i u"semilong" ; isl + ("-o" "o") ; FIXME: o u"semilong" ; osl + ("-u" "u") ; FIXME: u u"semilong" ; usl + ("-n" "ṉ") ; nsmac + ("\\.a" "ȧ") ; a with dot above ; adot + ("\\.c" "ċ") ; cdot + ("\\.h" "ḥ") ; hsdot + ("\\.m" "ṃ") ; msdot + ("\\.u" "ụ") ; usdot + ("\\.z" "ẓ") ; zsdot + ("Eth" "Ð") ; EDH + ("eth" "ð") ; edh + ("thorn" "þ") ; thorn + ("~a" "ã") ; atil + ("~e" "ẽ") ; etil + ("itil" "ĩ") + ("otil" "õ") + ("util" "ũ") + ("~n" "ñ") ; ntil + ("Atil" "Ã") + ("Etil" "Ẽ") + ("Itil" "Ĩ") + ("Otil" "Õ") + ("Util" "Ũ") + ("~N" "Ñ") ; Ntil + ("\\.n" "ṅ") ; ndot + ("\\.r" "ṛ") ; rsdot + ("yogh" "ȝ") ; yogh + ("deg" "°") + ("middot" "•") + ("root" "√") + ;; Greek letters + ("alpha" "α") + ("beta" "β") + ("gamma" "γ") + ("delta" "δ") + ("epsilon" "ε") + ("zeta" "ζ") + ("eta" "η") + ("theta" "θ") + ("iota" "ι") + ("approx" "κ") ; ap + ("lambda" "λ") + ("mu" "μ") + ("nu" "ν") + ("xi" "ξ") + ("omicron" "ο") + ("pi" "π") + ("rho" "ρ") + ("sigma" "σ") + ("sigmat" "ς") + ("tau" "τ") + ("upsilon" "υ") + ("phi" "φ") + ("chi" "χ") + ("psi" "ψ") + ("omega" "ω") + ("digamma" "ϝ") + ("ALPHA" "Α") + ("BETA" "Β") + ("Gamma" "Γ") ; GAMMA + ("Delta" "Δ") ; DELTA + ("EPSILON" "Ε") + ("ZETA" "Ζ") + ("ETA" "Η") + ("Theta" "Θ") ; THETA + ("IOTA" "Ι") + ("KAPPA" "Κ") + ("Lambda" "Λ") ; LAMBDA + ("MU" "Μ") + ("NU" "Ν") + ("XI" "Ξ") + ("Omicron" "Ο") ; OMICRON + ("Pi" "Π") ; PI + ("RHO" "Ρ") + ("Sigma" "Σ") ; SIGMA + ("Tau" "Τ") ; TAU + ("Upsilon" "Υ") ; UPSILON + ("PHI" "Φ") + ("Chi" "Χ") ; CHI + ("PSI" "Ψ") + ("Omega" "Ω") ; OMEGA + ;; FIXME: Vowels with a double dot below. There`s nothing suitable in the Unicode + ("add" "a") + ("udd" "u") + ("ADD" "A") + ("UDD" "U") + ;; Quotes + ("dagger" "†") + ("dag" "†") + ("u\\^" "§") ; par + ("and" "and") + ("or" "or") + ("sec" "˝") + ("[,C]" "Ç") + ("\"u" "ü") ; uum + ("'e" "é") ; eacute + ("\\^a" "â") ; acir + ("\"a" "ä") ; aum + ("`a" "à") ; agrave + ("\\*a" "å") ; aring + ("\\*u" "ů") ; uring + (",c" "ç") ; ccedil + ("cced" "ç") + ("\\^e" "ê") ; ecir + ("\"e" "ë") ; eum + ("`e" "è") ; egrave + ("\"i" "ï") ; ium + ("\\^i" "î") ; icir + ("`i" "ì") ; igrave + ("\"A" "Ä") ; Aum + ("\\*A" "Å") ; Aring + ("'E" "È") ; Eacute + ("ae" "æ") ; ae + ("AE" "Æ") ; AE + ("\\^o" "ô") ; ocir + ("\"o" "ö") ; oum + ("`o" "ò") ; ograve + ("'o" "ó") ; oacute + ("Oacute" "Ó") + ("\\^u" "û") ; ucir + ("`u" "ù") ; ugrave + ("'u" "ú") ; uacute + ("\"y" "ÿ") ; yum + ("\"O" "Ö") ; Oum + ("\"U" "Ü") + ("pound" "£") + ("'a" "á") ; aacute + ("'i" "í") ; iacute + ("frac23" "⅔") + ("frac13" "⅓") + ("frac12" "½") + ("frac14" "¼") + ;; ("\\?" "�") ; Place-holder for unknown or illegible character. + ("hand" "☞") ; pointing hand (printer's u"fist") ; hand ; and + ("sect" "§") ; sect + ("=a" "ā") ; amac + ("ng" "ṉ") ; u"n sub-macron" ; nsm + ("sharp" "♯") ; sharp + ("flat" "♭") ; flat + ("th" "th") ; th + ("=i" "ī") ; imac + ("=e" "ē") ; emac + ("\\.d" "ḍ") ; Sanskrit/Tamil d dot + ("\\.n" "ṇ") ; Sanskrit/Tamil n dot ; nsdot + ("\\.t" "ṭ") ; Sanskrit/Tamil t dot ; tsdot + ("a\\^" "ă") ; acr + ("e\\^" "ĕ") ; ecr + ("i\\^" "ĭ") ; icr + ("o\\^" "ŏ") ; ocr + ("!o" "ǒ") + ("OE" "Œ") ; OE + ("oe" "œ") ; oe + ("=O" "Ō") ; Omac + ("=o" "ō") ; omac + ("=u" "ū") ; umac + ("ocar" "ǒ") ; o hacek + ("=ae" "ǣ") ; aemac + ("u\\^" "ŭ") ; ucr + ("a\\^" "ă") + ("=y" "ȳ") ; ymac + ("asl" "a") ; FIXME: a u"semilong" (has a macron above with a short + ("-e" "e") ; FIXME: e u"semilong" ; esl + ("-i" "i") ; FIXME: i u"semilong" ; isl + ("-o" "o") ; FIXME: o u"semilong" ; osl + ("-u" "u") ; FIXME: u u"semilong" ; usl + ("-n" "ṉ") ; nsmac + ("\\.a" "ȧ") ; a with dot above ; adot + ("\\.c" "ċ") ; cdot + ("\\.h" "ḥ") ; hsdot + ("\\.m" "ṃ") ; msdot + ("\\.u" "ụ") ; usdot + ("\\.z" "ẓ") ; zsdot + ("Eth" "Ð") ; EDH + ("eth" "ð") ; edh + ("thorn" "þ") ; thorn + ("~a" "ã") ; atil + ("~e" "ẽ") ; etil + ("itil" "ĩ") + ("otil" "õ") + ("util" "ũ") + ("~n" "ñ") ; ntil + ("Atil" "Ã") + ("Etil" "Ẽ") + ("Itil" "Ĩ") + ("Otil" "Õ") + ("Util" "Ũ") + ("~N" "Ñ") ; Ntil + ("\\.n" "ṅ") ; ndot + ("\\.r" "ṛ") ; rsdot + ("yogh" "ȝ") ; yogh + ("deg" "°") + ("middot" "•") + ("root" "√") + ;; Greek letters + ("alpha" "α") + ("beta" "β") + ("gamma" "γ") + ("delta" "δ") + ("epsilon" "ε") + ("zeta" "ζ") + ("eta" "η") + ("theta" "θ") + ("iota" "ι") + ("approx" "κ") ; ap + ("lambda" "λ") + ("mu" "μ") + ("nu" "ν") + ("xi" "ξ") + ("omicron" "ο") + ("pi" "π") + ("rho" "ρ") + ("sigma" "σ") + ("sigmat" "ς") + ("tau" "τ") + ("upsilon" "υ") + ("phi" "φ") + ("chi" "χ") + ("psi" "ψ") + ("omega" "ω") + ("digamma" "ϝ") + ("ALPHA" "Α") + ("BETA" "Β") + ("Gamma" "Γ") ; GAMMA + ("Delta" "Δ") ; DELTA + ("EPSILON" "Ε") + ("ZETA" "Ζ") + ("ETA" "Η") + ("Theta" "Θ") ; THETA + ("IOTA" "Ι") + ("KAPPA" "Κ") + ("Lambda" "Λ") ; LAMBDA + ("MU" "Μ") + ("NU" "Ν") + ("XI" "Ξ") + ("Omicron" "Ο") ; OMICRON + ("Pi" "Π") ; PI + ("RHO" "Ρ") + ("Sigma" "Σ") ; SIGMA + ("Tau" "Τ") ; TAU + ("Upsilon" "Υ") ; UPSILON + ("PHI" "Φ") + ("Chi" "Χ") ; CHI + ("PSI" "Ψ") + ("Omega" "Ω") ; OMEGA + ;; FIXME: Vowels with a double dot below. There`s nothing suitable in the Unicode + ("add" "a") + ("udd" "u") + ("ADD" "A") + ("UDD" "U") + ;; Quotes + ("dagger" "†") + ("dag" "†") + ("u\\^" "§") ; par + ("and" "and") + ("or" "or") + ("times" "×") + ("sec" "˝")))) + (setq pronunciation + (replace-regexp-in-string + "\\.\\.\\." "…" + (replace-regexp-in-string + "\\*\\*\\*\\*\\*\\*\\*\\*" "✶" + pronunciation + ))) + (dolist (dcrt diacritics) + (setq pronunciation (replace-regexp-in-string + (concat "\\[" (car dcrt) "\\]") + (cadr dcrt) + pronunciation t))) + pronunciation)) + +(defun sdcv-format-reflow-text (text max-width &optional min-width initial-colunm indent sepregex) + (let* ((initial-col (or initial-colunm 0)) + (min-width (or min-width 1)) + (indent (or indent "")) + (sepregex (or sepregex "[ ,.]")) + (line-regex (format "\\(\\`.\\{%d,%d\\}\\(?:%s\\(?:.\\{1,%d\\}\\'\\)?\\|\\'\\)\\|.\\{%d\\}\\)\\(.*\\)" + min-width (- max-width (length indent)) + sepregex min-width (- max-width (length indent)))) + reflowed-text) + (setq text (replace-regexp-in-string "[[:space:]]+" " " text)) + (setq text + (if (> initial-col max-width) + (replace-regexp-in-string "\\` " "" text) + (replace-regexp-in-string + (format "\\`.\\{%d,%d\\}%s\\(?:.\\{1,%d\\}\\'\\)?\\|\\`" + (min min-width (- max-width initial-col)) (- max-width initial-col) + sepregex min-width) + (lambda (match) + (setq reflowed-text match) + "") + text))) + (while (not (string-empty-p text)) + (setq text + (if (<= (length text) max-width) + (progn (setq reflowed-text (concat reflowed-text + (unless (string-empty-p reflowed-text) + (concat "\n" indent)) + text)) "") + (replace-regexp-in-string + line-regex + (lambda (match) + (setq reflowed-text (concat reflowed-text "\n" indent (match-string 1 match))) + (match-string 2 match)) + text)))) + reflowed-text)) + +(defun sdcv-format-online-etym (entry &optional expected-word) + "Make an html ENTRY for WORD look nice. +Designed for an export of Douglas Harper's Online Etymology Dictionary, +sourced from http://tovotu.de/data/stardict/etymonline.zip." + (->> (string-join + (mapcar (lambda (e) (plist-get e :info)) + (-filter (lambda (e) (string= (plist-get e :dict) + (plist-get entry :dict))) + (sdcv-parse-results + (sdcv-oneshot-lookup + (replace-regexp-in-string " ?(.*)" " (*)" (plist-get entry :word)) ; sdcv accepts a glob + t (format "-0 -u '%s'" (replace-regexp-in-string "'" "\\'" (plist-get entry :dict)))))))) + (replace-regexp-in-string + "\\(?:\\`\\|\n\n\\)\\(.+?\\) (\\(.+?\\)\\([0-9]+\\)?) ?" + (lambda (match) + (let ((word (match-string 1 match)) + (pos (sdcv-format-expand-abbreviations (match-string 2 match))) + (index (match-string 3 match))) + (concat "\n\n\u200B\u200B\u200B" + (propertize word 'face 'bold) + " " + (propertize pos 'face '(bold font-lock-keyword-face)) + (when index + (propertize (concat " " index) 'face '(italic font-lock-doc-face))) + "\u2008\n\n")))) + (replace-regexp-in-string + "\\(.*?\\)" + (lambda (match) (propertize (match-string 1 match) 'face 'italic))) + (replace-regexp-in-string + "\\(.*?\\)" + (lambda (match) (propertize (match-string 1 match) 'face 'bold))) + (replace-regexp-in-string + "\\(.*?\\)" + (lambda (match) (propertize (match-string 1 match) 'face 'font-lock-constant-face))) + (replace-regexp-in-string + "\\(.*?\\)" + (lambda (match) (propertize (match-string 1 match) 'face 'font-lock-keyword-face))) + (replace-regexp-in-string + "\\(.*?\\)" + (lambda (match) (propertize (match-string 1 match) 'face 'font-lock-doc-face))) + (replace-regexp-in-string + "[0-9]\\{4\\}s?\\|[0-9]\\{2\\}c" + (lambda (match) (propertize match 'face 'font-lock-type-face))) + (replace-regexp-in-string + "\\(.*?\\)\\( (.+?)\\)?" + (lambda (match) + (let ((linked (match-string 1 match)) + (pos (sdcv-format-expand-abbreviations (match-string 2 match)))) + (concat + (propertize linked 'face 'font-lock-keyword-face) + (when pos (propertize (replace-regexp-in-string "\\([0-9]+\\))" " \\1)" pos) + 'face '(bold diff-context))))))) + (replace-regexp-in-string "

" "") + (replace-regexp-in-string + "

\\(.*?\\)

" + (lambda (match) + (concat + (sdcv-format-reflow-text (match-string 1 match) + 80 5) + "\n"))) + (replace-regexp-in-string + "^.\\{86,\\}" + (lambda (match) + (sdcv-format-reflow-text match 80 5))) + )) + +(defun sdcv-format-element (entry element &optional expected-word) + "Make an ENTRY for ELEMENT look nice. +Based on http://download.huzheng.org/dict.org/stardict-dictd_www.dict.org_elements-2.4.2.tar.bz2." + (replace-regexp-in-string + "^\\([a-z]+\\) +Symbol: \\([A-Za-z]+\\) +Atomic number: \\([0-9]+\\) +Atomic weight: \\((?[0-9.]+)?\\)" + (lambda (match) + (let ((element (match-string 1 match)) + (symbol (match-string 2 match)) + (number (match-string 3 match)) + (weight (match-string 4 match))) + (format + "┌────────────────┐ +│ %-3s %10s │ +│ %s %11s │ +└────────────────┘ +" + (propertize number 'face 'font-lock-function-name-face) + (propertize weight 'face 'font-lock-comment-face) + (propertize symbol 'face '(bold font-lock-keyword-face)) + (propertize element 'face 'font-lock-string-face)))) + (plist-get entry :info))) + +(defun sdcv-format-soule (entry &optional expected-word) + "Format an ENTRY for WORD in Soule's Dictionary of English Synonyms. +Designed using http://download.huzheng.org/bigdict/stardict-Soule_s_Dictionary_of_English_Synonyms-2.4.2.tar.bz2." + (->> (plist-get entry :info) + (replace-regexp-in-string ; categories + "^\\([IVX]+\\. \\)?\\([a-z.;& ]+\\)" + (lambda (match) + (concat + "\u200B\u200B\u200B" + (when case-fold-search + (propertize + 'face '(bold font-lock-constant-face))) + (propertize (sdcv-format-expand-abbreviations (match-string 2 match)) + 'face '(bold font-lock-keyword-face)) + "\u2008"))) + (replace-regexp-in-string + "^\\([0-9]+\\.\\) \n\\([^,.]*,?\\)" + (lambda (match) + (concat + "\u200B\u200B\u200B\u200B" + (propertize (match-string 1 match) + 'face '(bold font-lock-string-face)) + " " + (match-string 2 match) + "\u2008"))) + (replace-regexp-in-string + "^\\(.\\{81\\}\\)" + (lambda (match) + (sdcv-format-reflow-text match 80 1 0 " " "[, ]"))) + (replace-regexp-in-string + "," + (propertize "," 'face 'font-lock-type-face)))) ;;;;################################################################## ;;;; User Options, Variables @@ -378,7 +1813,7 @@ dictionary list. It has the form: Any cons cell here means using all dictionaries. ") -(defvar sdcv-program-path "sdcv" +(defvar sdcv-program-path "/usr/bin/sdcv" "The path of sdcv program.") (defvar sdcv-dictionary-path nil @@ -403,11 +1838,4 @@ If not, look up both of the words. word))) ") -(defvar sdcv-hit-face 'font-lock-type-face - "Face for search hits") -(defvar sdcv-failed-face 'font-lock-keyword-face - "Face for suggestions for a failed lookup.") -(defvar sdcv-heading-face 'highlight - "Face for heading of lookup") - -;;; sdcv-mode.el ends here +;;; sdcv.el ends here diff --git a/sdcv.gif b/sdcv.gif new file mode 100644 index 0000000..4461998 --- /dev/null +++ b/sdcv.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6974680872d12a11fb5cb0c9a50b94eeb3be8a836dcfe3e12f39963908a00c89 +size 990317