commit a0858e50ab443035605060eaf072fd3ae2d56e0b Author: Alex Kost Date: Wed Jul 16 09:49:41 2014 +0400 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2cf6546 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +tmp +*.elc +*.go diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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..cc4329c --- /dev/null +++ b/README.org @@ -0,0 +1,88 @@ +* About + +*guix.el* provides Emacs interface for [[http://www.gnu.org/software/guix/][Guix package manager]]. + +Well, actually that's not true yet, because this package is under +developement. Currently it is possible to search for packages and to +display information about the packages. + +* Requirements + +- Guix; +- Emacs 24.3 or above; +- [[https://github.com/jaor/geiser][Geiser]] as this package use it for interacting with guile process. + +* Installation + +** Automatic + +If you use [[https://github.com/quelpa/quelpa][Quelpa]], you can install the package like this: + +#+BEGIN_SRC emacs-lisp +(quelpa '(guix :fetcher github :repo "alezost/guix.el" :files ("*.el" "*.scm"))) +#+END_SRC + +** Manual + +For the manual installation, clone the repo, add the directory to the +=load-path= and add some autoloads for the interactive commands: + +#+BEGIN_SRC emacs-lisp +(add-to-list 'load-path "/path/to/guix-dir") +(autoload 'guix-search-by-name "guix" nil t) +(autoload 'guix-search-by-regexp "guix" nil t) +(autoload 'guix-all-available-packages "guix" nil t) +(autoload 'guix-newest-available-packages "guix" nil t) +#+END_SRC + +* Usage + +/Note:/ The first start of Guix REPL may take a long time, especially if +your Guix directories are not compiled, so be patient and do not press +=C-g=. If you want to disable auto-compilation, use the following +setting: + +#+BEGIN_SRC emacs-lisp +(setq guix-guile-program '("guile" "--no-auto-compile")) +#+END_SRC + +- To list available packages, use the following commands: + + : M-x guix-all-available-packages + : M-x guix-newest-available-packages + +- To search for packages, use: + + : M-x guix-search-by-regexp + + By default "name", "synopsis" and "description" of the packages will + be searched. This behavior can be changed with =guix-search-params= + variable. + +- To get packages by name, use: + + : M-x guix-search-by-name + +Information about the packages may be displayed in 2 types of buffers: +"_list_" and "_info_". The following keys are available in the both +buffer types by default: + +- =l= / =r= – go backward/forward by the history of the displayed + results (this history is similar to the history of the Emacs =help= or + =Info= modes); +- =g= – refresh current information; +- =C-c C-z= – go to the Guix REPL; +- =h= or =?= – describe current mode to see all available bindings. + +Also you can press =RET= in the list buffer to get more information +about the package. + +"Info" buffer contains some buttons (as usual you may use =TAB= / +=S-TAB= to move between buttons) which can be used to: + +- jump to a package location; +- browse home page of the package; +- describe packages from "Inputs" and "Native inputs" fields. + +/Hint:/ If you need several "list" or "info" buffers, you can simlpy +=M-x clone-buffer= them, and each buffer will have its own history. diff --git a/guix-backend.el b/guix-backend.el new file mode 100644 index 0000000..aebfbb7 --- /dev/null +++ b/guix-backend.el @@ -0,0 +1,194 @@ +;;; guix-backend.el --- Communication with Geiser + +;; Copyright © 2014 Alex Kost + +;; 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 . + +;;; Commentary: + +;; This file provides the code for interacting with Guile using Geiser. + +;;; Code: + +(require 'geiser-repl) + +(defvar guix-helper-file + (expand-file-name + "guix-helper.scm" + (file-name-directory (or load-file-name + (locate-library "guix")))) + "Scheme file used for getting info about packages.") + +(defvar guix-guile-program (or geiser-guile-binary "guile") + "Name of the guile executable used for Guix REPL. +May be either a string (the name of the executable) or a list of +strings of the form: + + (NAME . ARGS) + +Where ARGS is a list of arguments to the guile program.") + +(defun guix-get-guile-program () + "Return value suitable for `geiser-guile-binary'. +Result is a list containing `guix-guile-program' and arguments +for loading `guix-helper-file'." + (let ((guile (if (stringp guix-guile-program) + (list guix-guile-program) + guix-guile-program))) + (append guile (list "-l" guix-helper-file)))) + + +;;; REPL + +(defcustom guix-repl-startup-time 30000 + "Time, in milliseconds, to wait for Guix REPL to startup. +Same as `geiser-repl-startup-time' but is used for Guix REPL. +If you have a slow system, try to increase this time." + :type 'integer + :group 'guix) + +(defcustom guix-repl-buffer-name "*Guix REPL*" + "Default name of a Geiser REPL buffer used for Guix." + :type 'string + :group 'guix) + +(defcustom guix-after-start-repl-hook () + "Hook called after Guix REPL is started." + :type 'hook + :group 'guix) + +(defvar guix-repl-buffer nil + "Geiser REPL buffer used for communicating with Guix.") + +(defun guix-start-repl () + "Start Geiser REPL configured for Guix." + ;; A mix of the code from `guix-geiser-repl--start-repl' and + ;; `geiser-repl--to-repl-buffer'. + (message "Starting Geiser REPL for Guix ...") + (let ((impl 'guile) + (geiser-guile-binary (guix-get-guile-program)) + (geiser-repl-startup-time guix-repl-startup-time) + (repl (get-buffer-create guix-repl-buffer-name))) + (with-current-buffer repl + (geiser-repl-mode) + (geiser-impl--set-buffer-implementation impl) + (geiser-repl--autodoc-mode -1) + (goto-char (point-max)) + (let* ((prompt-re (geiser-repl--prompt-regexp impl)) + (deb-prompt-re (geiser-repl--debugger-prompt-regexp impl)) + (prompt (geiser-con--combined-prompt prompt-re deb-prompt-re))) + (or prompt-re + (error "Oh no! Guix REPL has not been started")) + (geiser-repl--start-scheme impl nil prompt) + (geiser-repl--quit-setup) + (geiser-repl--history-setup) + (add-to-list 'geiser-repl--repls (current-buffer)) + (geiser-repl--set-this-buffer-repl (current-buffer)) + (setq geiser-repl--connection + (geiser-con--make-connection (get-buffer-process (current-buffer)) + prompt-re + deb-prompt-re)) + (geiser-repl--startup impl nil) + (geiser-repl--autodoc-mode 1) + (geiser-company--setup geiser-repl-company-p) + (add-hook 'comint-output-filter-functions + 'geiser-repl--output-filter + nil + t) + (set-process-query-on-exit-flag (get-buffer-process (current-buffer)) + geiser-repl-query-on-kill-p) + (setq guix-repl-buffer repl) + (message "Guix REPL has been started.") + (run-hooks 'guix-after-start-repl-hook))))) + +(defun guix-get-repl-buffer () + "Return Guix REPL buffer; start REPL if needed." + (or (get-buffer-process guix-repl-buffer) + (guix-start-repl)) + guix-repl-buffer) + +(defun guix-switch-to-repl () + "Switch to Guix REPL." + (interactive) + (geiser-repl--switch-to-buffer (guix-get-repl-buffer))) + + +;;; Evaluating expressions + +(defun guix-make-guile-expression (fun &rest args) + "Return string containing a guile expression for calling FUN with ARGS." + (format "(%S %s)" fun + (mapconcat (lambda (arg) + (concat (and (or (symbolp arg) (listp arg)) + "'") + (prin1-to-string arg))) + args + " "))) + +(defun guix-eval (str &optional wrap) + "Evaluate guile expression STR. +If WRAP is non-nil, wrap STR into (begin ...) form. +Return a list of strings with result values of evaluation." + (with-current-buffer (guix-get-repl-buffer) + (let* ((wrapped (if wrap (geiser-debug--wrap-region str) str)) + (code `(:eval (:scm ,wrapped))) + (ret (geiser-eval--send/wait code))) + (if (geiser-eval--retort-error ret) + (error "Error in evaluating guile expression: %s" + (geiser-eval--retort-output ret)) + (cdr (assq 'result ret)))))) + +(defun guix-eval-read (str &optional wrap) + "Evaluate guile expression STR. +For the meaning of WRAP, see `guix-eval'. +Return elisp expression of the first result value of evaluation." + ;; Parsing scheme code with elisp `read' is probably not the best idea. + (read (replace-regexp-in-string + "#f\\|#" "nil" + (replace-regexp-in-string + "#t" "t" (car (guix-eval str wrap)))))) + + +;;; Getting packages info + +(defvar guix-search-type-alist + '((name . find-packages-by-spec) + (regexp . find-packages-by-regexp) + (all-available . all-available-packages) + (newest-available . newest-available-packages)) + "Alist of available search options. +Each association has a form: + + (TYPE . FUN) + +TYPE is a search type. +FUN is a name of guile function used for searching.") + +(defun guix-get-packages (type vals) + "Search for Guix packages and return results. + +TYPE is a search type from `guix-search-type-alist'. +It defines a search function which is called with VALS as +arguments. + +Returning value is a list of the form of `guix-packages'." + (let ((fun (cdr (assq type guix-search-type-alist)))) + (or fun (error "Wrong search type ‘%s’" type)) + (let ((packages (guix-eval-read + (apply #'guix-make-guile-expression fun vals)))) + (or packages (error "Packages not found"))))) + +(provide 'guix-backend) + +;;; guix-backend.el ends here diff --git a/guix-base.el b/guix-base.el new file mode 100644 index 0000000..0e6f0df --- /dev/null +++ b/guix-base.el @@ -0,0 +1,247 @@ +;;; guix-base.el --- Common definitions + +;; Copyright © 2014 Alex Kost + +;; 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 . + +;;; Commentary: + +;; This file provides some base and common definitions for guix.el +;; package. + +;; List and info buffers have many common patterns that are defined +;; using `guix-define-buffer-type' macro from this file. + +;;; Code: + +(require 'cl-macs) +(require 'guix-backend) + + +;;; Parameters (fields) of the packages + +(defvar guix-param-alist + '((name . "Name") + (version . "Version") + (license . "License") + (synopsis . "Synopsis") + (description . "Description") + (home-url . "Home page") + (outputs . "Outputs") + (inputs . "Inputs") + (native-inputs . "Native inputs") + (location . "Location")) + "Association list of names and titles of package parameters. +Titles are used for displaying package information.") + +(defun guix-get-param-title (param) + "Return a title of a package parameter PARAM." + (let ((desc (cdr (assq param guix-param-alist)))) + (or desc + (progn + (setq desc (symbol-name param)) + (message "Couldn't find ‘%s’ in `guix-param-alist'." + desc) + desc)))) + +(defsubst guix-get-param-val (param info) + "Return a value of a parameter PARAM from a package INFO. +INFO is alist of parameters and their values." + (cdr (assq param info))) + +(defun guix-get-name-spec (name version &optional output) + "Return Guix package specification by its NAME, VERSION and OUTPUT." + (concat name "-" version + (when output (concat ":" output)))) + +(defun guix-get-full-name (info) + "Return full name specification of the package by its INFO." + (guix-get-name-spec (guix-get-param-val 'name info) + (guix-get-param-val 'version info))) + + +;;; Location of the packages + +(defvar guix-guile-site-directory nil + "Default guile site directory. +If it is not set by a user, it is set after starting Guile REPL.") + +(defun guix-set-site-directory () + "Set `guix-guile-site-directory' if needed." + (or guix-guile-site-directory + (setq guix-guile-site-directory + (guix-eval-read (guix-make-guile-expression '%site-dir))))) + +(add-hook 'guix-after-start-repl-hook 'guix-set-site-directory) + +(defun guix-find-location (location) + "Go to LOCATION of a package. +LOCATION is a string of the form: + + \"PATH:LINE:COLUMN\" + +If PATH is relative, it is considered to be relative to +`guix-guile-site-directory'." + (cl-multiple-value-bind (path line col) + (split-string location ":") + (let ((file (expand-file-name path guix-guile-site-directory)) + (line (string-to-number line)) + (col (string-to-number col))) + (find-file file) + (goto-char (point-min)) + (forward-line (- line 1)) + (move-to-column col) + (recenter 1)))) + + +;;; Common definitions for buffer types + +(defvar-local guix-packages nil + "List of the currently displayed packages. +Each element of the list is alist with package info of the +following form: + + ((PARAM . VAL) ...) + +PARAM is a parameter name from `guix-param-alist'. +VAL is a value of this parameter.") +(put 'guix-packages 'permanent-local t) + +(defvar-local guix-search-type nil + "Type of the current search. +Function `guix-get-packages' called with `guix-search-type' and +`guix-search-vals' returned the current `guix-packages'.") +(put 'guix-search-type 'permanent-local t) + +(defvar-local guix-search-vals nil + "Values of the current search. +Function `guix-get-packages' called with `guix-search-type' and +`guix-search-vals' returned the current `guix-packages'.") +(put 'guix-search-vals 'permanent-local t) + +(defsubst guix-set-vars (packages search-type search-vals) + (setq guix-packages packages + guix-search-vals search-vals + guix-search-type search-type)) + +(defmacro guix-define-buffer-type (type parent-mode) + "Define common stuff for TYPE of buffer for displaying packages. +PARENT-MODE is a parent mode for the `guix-TYPE-mode'." + (let ((type-str (symbol-name type))) + (let ((group (intern (concat "guix-" type-str))) + (mode (intern (concat "guix-" type-str "-mode"))) + (mode-map (intern (concat "guix-" type-str "-mode-map"))) + (mode-init-fun (intern (concat "guix-" type-str "-mode-initialize"))) + (buf-name-var (intern (concat "guix-" type-str "-buffer-name"))) + (mode-name-var (intern (concat "guix-" type-str "-mode-name"))) + (revert-var (intern (concat "guix-" type-str "-revert-no-confirm"))) + (revert-fun (intern (concat "guix-" type-str "-revert"))) + (redisplay-fun (intern (concat "guix-" type-str "-redisplay"))) + (history-var (intern (concat "guix-" type-str "-history-size"))) + (history-fun (intern (concat "guix-" type-str "-make-history-item"))) + (get-fun (intern (concat "guix-" type-str "-get-packages"))) + (set-fun (intern (concat "guix-" type-str "-set"))) + (show-fun (intern (concat "guix-" type-str "-show-packages"))) + (insert-fun (intern (concat "guix-" type-str "-insert-packages")))) + `(progn + (defgroup ,group nil + ,(concat "Buffer with Guix packages.") + :prefix ,(concat "guix-" type-str "-") + :group 'guix) + + (defcustom ,buf-name-var ,(concat "*Guix Package " type-str "*") + ,(concat "Default name of the " type-str " buffer.") + :type 'string + :group ',group) + + (defcustom ,history-var 30 + ,(concat "Maximum number of items saved in the history of the " type-str " buffer.\n" + "If 0, the history is disabled.") + :type 'integer + :group ',group) + + (defcustom ,revert-var nil + ,(concat "If non-nil, do not ask to confirm for reverting the " type-str " buffer.") + :type 'boolean + :group ',group) + + (define-derived-mode ,mode ,parent-mode ,(concat "Guix-" type-str) + ,(concat "Major mode for displaying information about Guix packages.\n\n" + "\\{guix-" type-str "-mode-map}") + (setq-local revert-buffer-function ',revert-fun) + (setq-local guix-history-size ,history-var) + (and (fboundp ',mode-init-fun) (,mode-init-fun))) + + (defun ,revert-fun (ignore-auto noconfirm) + "Update information in the current buffer. +The function is suitable for `revert-buffer-function'. +See `revert-buffer' for the meaning of IGNORE-AUTO and NOCONFIRM." + (when (or ,revert-var + noconfirm + (y-or-n-p "Update current information? ")) + (let ((packages (,get-fun guix-search-type guix-search-vals))) + (,set-fun packages guix-search-type guix-search-vals t)))) + + (defun ,redisplay-fun () + "Redisplay current information. +This function will not update the information, use +\"\\[revert-buffer]\" if you want the full update." + (interactive) + (,show-fun guix-packages)) + + (defun ,history-fun () + "Make and return a history item for the current buffer." + (list (lambda (packages search-type search-vals) + (,show-fun packages) + (guix-set-vars packages search-type search-vals)) + guix-packages guix-search-type guix-search-vals)) + + (defun ,set-fun (packages search-type search-vals &optional history-replace) + ,(concat "Set up the " type-str " buffer.\n" + "Display PACKAGES, set variables and make history item.\n\n" + "PACKAGES should have a form of `guix-packages'.\n\n" + "See `guix-get-packages' for the meaning of SEARCH-TYPE and\n" + "SEARCH-VALS.\n\n" + "If HISTORY-REPLACE is non-nil, replace current history item,\n" + "otherwise add the new one.") + (let ((buf (if (eq major-mode ',mode) + (current-buffer) + (get-buffer-create ,buf-name-var)))) + (with-current-buffer buf + (,show-fun packages) + (guix-set-vars packages search-type search-vals) + (funcall (if history-replace + #'guix-history-replace + #'guix-history-add) + (,history-fun))) + (pop-to-buffer-same-window buf))) + + (defun ,show-fun (packages) + "Display PACKAGES in the current buffer." + (let ((inhibit-read-only t)) + (erase-buffer) + (,mode) + (,insert-fun packages)) + (when (cdr packages) + (message "%d packages." (length packages)))) + + (let ((map ,mode-map)) + (define-key map (kbd "l") 'guix-history-back) + (define-key map (kbd "r") 'guix-history-forward) + (define-key map (kbd "R") ',redisplay-fun) + (define-key map (kbd "C-c C-z") 'guix-switch-to-repl)))))) + +(provide 'guix-base) + +;;; guix-base.el ends here diff --git a/guix-helper.scm b/guix-helper.scm new file mode 100644 index 0000000..b63cdb7 --- /dev/null +++ b/guix-helper.scm @@ -0,0 +1,137 @@ +;;; guix-helper.scm --- Scheme code for guix.el package + +;; Copyright © 2014 Alex Kost + +;; 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 . + +;;; Code: + +(use-modules + (ice-9 vlist) + (srfi srfi-1) + (srfi srfi-11) + (gnu packages) + (guix packages) + (guix ui) + (guix licenses)) + +(define (funcall-or-map fun obj) + (if (list? obj) + (map fun obj) + (fun obj))) + +(define (package-inputs-names inputs) + "Return list of full names of the packages from INPUTS. +INPUTS can be either package inputs or native inputs." + (fold (lambda (input res) + (let ((pkg (cadr input))) + (if (package? pkg) + (cons (package-full-name pkg) res) + res))) + '() + inputs)) + +(define (package-license-names package) + "Return license name or list of license names of the PACKAGE." + (funcall-or-map (lambda (l) + (and (license? l) (license-name l))) + (package-license package))) + +(define package-field-alist + (list + (cons 'name package-name) + (cons 'version package-version) + (cons 'license package-license-names) + (cons 'synopsis package-synopsis) + (cons 'description package-description) + (cons 'home-url package-home-page) + (cons 'outputs package-outputs) + (cons 'inputs (lambda (pkg) (package-inputs-names + (package-inputs pkg)))) + (cons 'native-inputs (lambda (pkg) (package-inputs-names + (package-native-inputs pkg)))) + (cons 'location (lambda (pkg) (location->string + (package-location pkg)))))) + +(define (package-field-accessor field) + "Return the procedure of a package FIELD from `package-field-alist'." + (cdr (assq field package-field-alist))) + +(define (package-field package field) + "Return the value of a PACKAGE FIELD." + ((package-field-accessor field) package)) + +(define (package-info package . fields) + "Return info about the PACKAGE. +FIELDS are field names from `package-field-alist', if FIELDS are not +specified, use all fields. +Returning value is alist of names and values of package fields." + (let ((use-all-fields (null? fields))) + (let loop ((field-alist package-field-alist) + (res '())) + (if (null? field-alist) + res + (let* ((field-elem (car field-alist)) + (field (car field-elem)) + (fun (cdr field-elem))) + (loop (cdr field-alist) + (if (or use-all-fields + (memq field fields)) + (cons (cons field (fun package)) res) + res))))))) + +(define (find-packages-by-spec spec . fields) + "Search for packages by name specification SPEC. +Return list of package info. +For the meaning of FIELDS, see `package-info'." + (let-values (((name version out) + (package-specification->name+version+output spec))) + (map (lambda (pkg) + (apply package-info pkg fields)) + (find-packages-by-name name version)))) + +(define (package-match? regexp package fields) + "Return #t if REGEXP matches any PACKAGE field from FIELDS." + (any (lambda (field) + (let ((val (package-field package field))) + (and (string? val) (regexp-exec regexp val)))) + fields)) + +(define (find-packages-by-regexp regexp match-fields . ret-fields) + "Search for packages by REGEXP string. +MATCH-FIELDS is a list of fields that REGEXP can match. +For the meaning of RET-FIELDS, see `package-info'. +Return list of package info." + (let ((re (make-regexp regexp regexp/icase))) + (fold-packages (lambda (pkg res) + (if (package-match? re pkg match-fields) + (cons (apply package-info pkg ret-fields) res) + res)) + '()))) + +(define (newest-available-packages . fields) + "Return list of package info for the newest available packages. +For the meaning of FIELDS, see `package-info'." + (vhash-fold (lambda (key val res) + (cons (apply package-info (cadr val) fields) res)) + '() + (find-newest-available-packages))) + +(define (all-available-packages . fields) + "Return list of package info for all available packages. +For the meaning of FIELDS, see `package-info'." + (fold-packages (lambda (pkg res) + (cons (apply package-info pkg fields) res)) + '())) + diff --git a/guix-history.el b/guix-history.el new file mode 100644 index 0000000..ba85457 --- /dev/null +++ b/guix-history.el @@ -0,0 +1,90 @@ +;;; guix-history.el --- History of buffer information + +;; Copyright © 2014 Alex Kost + +;; 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 . + +;;; Commentary: + +;; This file provides support for history of buffers similar to the +;; history of a `help-mode' buffer. + +;;; Code: + +(require 'cl-macs) + +(defvar-local guix-history-stack-item nil + "Current item of the history. +A list of the form (FUNCTION [ARGS ...]). +The item is used by calling (apply FUNCTION ARGS).") +(put 'guix-history-stack-item 'permanent-local t) + +(defvar-local guix-history-back-stack nil + "Stack (list) of visited items. +Each element of the list has a form of `guix-history-stack-item'.") +(put 'guix-history-back-stack 'permanent-local t) + +(defvar-local guix-history-forward-stack nil + "Stack (list) of items visited with `guix-history-back'. +Each element of the list has a form of `guix-history-stack-item'.") +(put 'guix-history-forward-stack 'permanent-local t) + +(defvar guix-history-size 0 + "Maximum number of items saved in history. +If 0, the history is disabled.") + +(defun guix-history-add (item) + "Add ITEM to history." + (and guix-history-stack-item + (push guix-history-stack-item guix-history-back-stack)) + (setq guix-history-forward-stack nil + guix-history-stack-item item) + (when (>= (length guix-history-back-stack) + guix-history-size) + (setq guix-history-back-stack + (cl-loop for elt in guix-history-back-stack + for i from 1 to guix-history-size + collect elt)))) + +(defun guix-history-replace (item) + "Replace current item in history with ITEM." + (setq guix-history-stack-item item)) + +(defun guix-history-goto (item) + "Go to the ITEM of history. +ITEM should have the form of `guix-history-stack-item'." + (or (listp item) + (error "Wrong value of history element")) + (setq guix-history-stack-item item) + (apply (car item) (cdr item))) + +(defun guix-history-back () + "Go back to the previous element of history in the current buffer." + (interactive) + (or guix-history-back-stack + (user-error "No previous element in history")) + (push guix-history-stack-item guix-history-forward-stack) + (guix-history-goto (pop guix-history-back-stack))) + +(defun guix-history-forward () + "Go forward to the next element of history in the current buffer." + (interactive) + (or guix-history-forward-stack + (user-error "No next element in history")) + (push guix-history-stack-item guix-history-back-stack) + (guix-history-goto (pop guix-history-forward-stack))) + +(provide 'guix-history) + +;;; guix-history.el ends here diff --git a/guix-info.el b/guix-info.el new file mode 100644 index 0000000..dbec58b --- /dev/null +++ b/guix-info.el @@ -0,0 +1,269 @@ +;;; guix-info.el --- Major mode for displaying Guix packages + +;; Copyright © 2014 Alex Kost + +;; 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 . + +;;; Commentary: + +;; This file provides a help-like buffer for displaying information +;; about Guix packages. + +;;; Code: + +(require 'guix-history) +(require 'guix-base) +(require 'guix-backend) +(require 'guix-utils) + +(defvar guix-info-mode-map + (let ((map (make-sparse-keymap))) + (set-keymap-parent + map (make-composed-keymap button-buffer-map + special-mode-map)) + map) + "Keymap for `guix-info-mode'.") + +(guix-define-buffer-type info special-mode) + +(defface guix-info-param-title + '((t :inherit font-lock-type-face)) + "Face used for a title of a package parameter." + :group 'guix-info) + +(defface guix-info-name + '((t :inherit font-lock-keyword-face)) + "Face used for a name of a package." + :group 'guix-info) + +(defface guix-info-version + '((t :inherit font-lock-builtin-face)) + "Face used for a version of a package." + :group 'guix-info) + +(defface guix-info-synopsis + '((t :inherit font-lock-doc-face)) + "Face used for a synopsis of a package." + :group 'guix-info) + +(defface guix-info-description + '((t)) + "Face used for a description of a package." + :group 'guix-info) + +(defface guix-info-license + '((t :inherit font-lock-string-face)) + "Face used for a license of a package." + :group 'guix-info) + +(defface guix-info-location + '((t :inherit button)) + "Face used for a location of a package." + :group 'guix-info) + +(defface guix-info-url + '((t :inherit button)) + "Face used for URLs." + :group 'guix-info) + +(defface guix-info-inputs + '((t :inherit button)) + "Face used for inputs of a package." + :group 'guix-info) + +(defface guix-info-native-inputs + '((t :inherit guix-info-inputs)) + "Face used for native inputs of a package." + :group 'guix-info) + +(defcustom guix-info-ignore-empty-vals nil + "If non-nil, do not display parameters with nil values." + :type 'boolean + :group 'guix-info) + +(defvar guix-info-param-title-format "%-15s: " + "String used to format a title of each package parameter. +It should be a '%s'-sequence. After inserting a title formatted +with this string, a value of the parameter is inserted.") + +(defvar guix-info-multiline-prefix (make-string 17 ?\s) + "String used to format multi-line parameter values. +If a value occupies more than one line, this string is inserted +in the beginning of each line after the first one.") + +(defvar guix-info-fill-column 60 + "Column used for filling (word wrapping) parameters with long lines. +If a value is not multi-line and it occupies more than this +number of characters, it will be split into several lines.") + +(defvar guix-info-delimiter "\n\f\n" + "String used to separate packages info.") + +(defvar guix-info-insert-param-alist + '((name . guix-info-name) + (version . guix-info-version) + (license . guix-info-license) + (synopsis . guix-info-synopsis) + (description . guix-info-description) + (outputs . guix-info-outputs) + (home-url . guix-info-insert-url) + (inputs . guix-info-insert-inputs) + (native-inputs . guix-info-insert-native-inputs) + (location . guix-info-insert-location)) + "Methods of inserting package parameters. +Car of each assoc is a symbol from `guix-param-alist'. +Cdr is either a face name, used for the inserted value, or a +function, which is called with the value as the argument.") + +(defvar guix-info-params + '(name version outputs synopsis location home-url license + inputs native-inputs description) + "List of parameters displayed in the info buffer. +Each parameter should be a symbol from `guix-param-alist'. +The order of displayed parameters is the same as in this list. +If nil, display all parameters with no particular order.") + +(defalias 'guix-info-get-packages 'guix-get-packages) + +(defun guix-info-get-show-packages (search-type &rest search-vals) + "Search for packages and show results in info buffer. +See `guix-info-get-packages' for the meaning of SEARCH-TYPE and +SEARCH-VALS." + (let ((packages (guix-info-get-packages search-type search-vals))) + (guix-info-set packages search-type search-vals))) + +(defun guix-info-insert-packages (packages) + "Display PACKAGES in the current info buffer. +PACKAGES should have a form of `guix-packages'." + (guix-mapinsert (lambda (info) + (apply #'guix-info-insert-info + info guix-info-params)) + packages + guix-info-delimiter) + (goto-char (point-min))) + +(defun guix-info-insert-info (info &rest params) + "Insert (pretty print) package INFO into the current buffer. +Each element from PARAMS is a parameter to insert (symbol from +`guix-param-alist')." + (mapc (lambda (param) + (guix-info-insert-param + param (guix-get-param-val param info))) + params)) + +(defun guix-info-insert-param (param val) + "Insert description and value VAL of a parameter PARAM at point. +PARAM is a symbol from `guix-param-alist'." + (unless (and guix-info-ignore-empty-vals (null val)) + (let ((title (guix-get-param-title param)) + (insert-val (cdr (assq param guix-info-insert-param-alist)))) + (insert (format guix-info-param-title-format + (guix-get-string title 'guix-info-param-title))) + (if (and val (functionp insert-val)) + (funcall insert-val val) + (guix-info-insert-val + val (and (facep insert-val) insert-val))) + (insert "\n")))) + +(defun guix-info-insert-location (location) + "Make button from file LOCATION and insert it at point." + (insert-button + location + 'face 'guix-info-location + 'action (lambda (btn) + (guix-find-location (button-label btn))) + 'follow-link t + 'help-echo "mouse-2, RET: Find location of this package")) + +(defun guix-info-insert-url (url) + "Make button from URL and insert it at point." + (insert-button + url + 'face 'guix-info-url + 'action (lambda (btn) (browse-url (button-label btn))) + 'follow-link t + 'help-echo "mouse-2, RET: Browse URL")) + +(defun guix-info-insert-inputs (inputs) + "Make buttons from INPUTS and insert those at point." + (guix-info-insert-package-names inputs 'guix-info-inputs)) + +(defun guix-info-insert-native-inputs (inputs) + "Make buttons from native INPUTS and insert those at point." + (guix-info-insert-package-names inputs 'guix-info-native-inputs)) + +(defun guix-info-insert-package-names (names face) + "Make buttons from package NAMES and insert those at point. +NAMES is a list of strings. +Propertize buttons with FACE." + (guix-info-insert-val + (with-temp-buffer + (guix-mapinsert (lambda (name) + (guix-info-insert-package-name name face)) + names + guix-list-separator) + (buffer-substring (point-min) (point-max))))) + +(defun guix-info-insert-package-name (name face) + "Make button and insert package NAME at point. +Propertize package button with FACE." + (insert-text-button + name + 'face face + 'action (lambda (btn) + (guix-info-get-show-packages 'name (button-label btn))) + 'follow-link t + 'help-echo "mouse-2, RET: Describe the package")) + +(defun guix-info-insert-val (val &optional face) + "Format and insert parameter value at point. + +If VAL is a one-line string longer than `guix-info-fill-column', +split it into several shorter lines. + +If FACE is non-nil, propertize inserted line(s) with this FACE." + (if (stringp val) + (let ((strings (split-string val "\n *"))) + (and (null (cdr strings)) ; if not multi-line + (> (length val) guix-info-fill-column) + (setq strings + (split-string (guix-info-get-filled-string val) + "\n"))) + (insert (guix-get-string (car strings) face)) + (guix-info-insert-strings (cdr strings) face)) + (insert (guix-get-string val face)))) + +(defun guix-info-get-filled-string (str &optional col) + "Return string by filling a string STR. +COL controls the width for filling. +If COL is nil, use `guix-info-fill-column'." + (or col (setq col guix-info-fill-column)) + (with-temp-buffer + (insert str) + (let ((fill-column col)) + (fill-region (point-min) (point-max))) + (buffer-string))) + +(defun guix-info-insert-strings (strings &optional face) + "Insert STRINGS at point. +Each string is inserted on a new line after +`guix-info-multiline-prefix'. +If FACE is non-nil, propertize inserted lines with it." + (dolist (str strings) + (insert "\n" guix-info-multiline-prefix + (guix-get-string str face)))) + +(provide 'guix-info) + +;;; guix-info.el ends here diff --git a/guix-list.el b/guix-list.el new file mode 100644 index 0000000..089e6c7 --- /dev/null +++ b/guix-list.el @@ -0,0 +1,189 @@ +;;; guix-list.el --- Major mode for displaying Guix packages + +;; Copyright © 2014 Alex Kost + +;; 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 . + +;;; Commentary: + +;; This file provides a list-like buffer for displaying information +;; about Guix packages. + +;;; Code: + +(require 'tabulated-list) +(require 'guix-info) +(require 'guix-history) +(require 'guix-base) +(require 'guix-backend) +(require 'guix-utils) + +(defvar guix-list-mode-map + (let ((map (make-sparse-keymap))) + (set-keymap-parent map tabulated-list-mode-map) + (define-key map (kbd "RET") 'guix-list-describe-package) + map) + "Keymap for `guix-list-mode'.") + +(guix-define-buffer-type list tabulated-list-mode) + +(defcustom guix-list-single-package nil + "If non-nil, list a package even if it is the only matching result. +If nil, show the single package in info buffer." + :type 'boolean + :group 'guix-list) + +(defvar guix-list-column-format + '((name 20 t) + (version 10 nil) + (synopsis 30 nil)) + "List of columns displayed in a buffer with a list of packages. +Each element of the list should have the form (NAME WIDTH SORT . PROPS). +NAME is a parameter from `guix-param-alist'. +For the meaning of WIDTH, SORT and PROPS, see `tabulated-list-format'.") + +(defvar guix-list-column-name-alist () + "Alist of titles of columns. +Each association is a cons of parameter name and column name. +If no parameter is not found in this alist, the value from +`guix-param-alist' is used for a column name.") + +(defvar guix-list-column-value-alist + '((synopsis . guix-list-get-one-line) + (description . guix-list-get-one-line)) + "Alist for parameter values inserted in columns. + +Each association is a cons of parameter name from +`guix-param-alist' and a function returning a value +that will be inserted. + +The function is called with two arguments: the first one is a +value of the parameter; the second argument is a package +info (alist of parameters and their values).") + +(defvar guix-list-required-params '(name version) + "List of required package parameters. + +Parameters displayed in a list buffer (columns) and parameters +from this list are received for every package. + +May be a special value `all', in which case all supported +parameters are received (this may be very slow for lists with a +big number of packages). + +Do not remove `name' and `version' from this list as they are +required for identifying a package.") + +(defun guix-list-get-params-for-receiving () + "Return list of package parameters that should be received." + (let ((params (mapcar #'car guix-list-column-format))) + (dolist (param guix-list-required-params params) + (add-to-list 'params param)))) + +(defun guix-list-mode-initialize () + "Initial settings for `guix-list-mode'." + ;; (setq tabulated-list-padding 2) + (setq tabulated-list-format (guix-list-get-list-format)) + (setq tabulated-list-sort-key + (list (guix-get-param-title 'name))) + (tabulated-list-init-header)) + +(defun guix-list-get-packages (search-type search-vals) + "Search for Guix packages and return results. + +See `guix-get-packages' for the meaning of SEARCH-TYPE and +SEARCH-VALS. + +If `guix-list-required-params' is not `all', then parameters from +this list are appended to SEARCH-VALS." + (guix-get-packages + search-type + (if (equal guix-list-required-params 'all) + search-vals + (append search-vals (guix-list-get-params-for-receiving))))) + +(defun guix-list-get-show-packages (search-type &rest search-vals) + "Search for packages and show results. + +See `guix-list-get-packages' for the meaning of SEARCH-TYPE and +SEARCH-VALS. + +Results may be displayed in the info buffer, see +`guix-list-single-package' for details." + (let ((packages (guix-list-get-packages search-type search-vals))) + (if (or guix-list-single-package + (cdr packages)) + (guix-list-set packages search-type search-vals) + (unless (equal guix-list-required-params 'all) + ;; If we don't have all info, we should receive it + (setq packages (guix-info-get-packages search-type search-vals))) + (guix-info-set packages search-type search-vals)))) + +(defun guix-list-insert-packages (packages) + "Display PACKAGES in the current list buffer." + (setq tabulated-list-entries (guix-list-get-entries packages)) + (tabulated-list-print)) + +(defun guix-list-get-list-format () + "Return package list specification for `tabulated-list-format'." + (apply #'vector + (mapcar + (lambda (col-spec) + (let ((name (car col-spec))) + (cons (or (cdr (assq name guix-list-column-name-alist)) + (guix-get-param-title name)) + (cdr col-spec)))) + guix-list-column-format))) + +(defun guix-list-get-entries (packages) + "Return list of values for `tabulated-list-entries'. +Values are taken from PACKAGES which should have the form of +`guix-list-packages'." + (mapcar (lambda (info) + (list (guix-get-full-name info) + (guix-list-get-entry info))) + packages)) + +(defun guix-list-get-entry (info) + "Return array of values for `tabulated-list-entries'. +Package parameters are taken from INFO which should be an alist +of parameters and values." + (apply #'vector + (mapcar + (lambda (col-spec) + (let* ((param (car col-spec)) + (val (guix-get-param-val param info)) + (fun (cdr (assq param guix-list-column-value-alist)))) + (if (and val fun) + (funcall fun val info) + (guix-get-string val)))) + guix-list-column-format))) + +(defun guix-list-get-one-line (str _) + "Return one-line string from a multi-line STR." + (guix-get-one-line str)) + +(defun guix-list-get-full-name () + "Return full name of the current package." + (or (tabulated-list-get-id) + (user-error "No package here"))) + +(defun guix-list-describe-package () + "Describe the current package." + (interactive) + (guix-info-get-show-packages 'name (guix-list-get-full-name))) + +(provide 'guix-list) + +;;; guix-list.el ends here diff --git a/guix-utils.el b/guix-utils.el new file mode 100644 index 0000000..9524800 --- /dev/null +++ b/guix-utils.el @@ -0,0 +1,66 @@ +;;; guix-utils.el --- General utility functions + +;; Copyright © 2014 Alex Kost + +;; 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 . + +;;; Commentary: + +;; This file provides auxiliary general functions for guix.el package. + +;;; Code: + +(defvar guix-true-string "Yes") +(defvar guix-false-string "–") +(defvar guix-list-separator ", ") + +(defun guix-get-string (val &optional face) + "Convert VAL into a string and return it. + +VAL can be an expression of any type. +If VAL is t/nil, it is replaced with +`guix-true-string'/`guix-false-string'. +If VAL is list, its elements are concatenated using +`guix-list-separator'. + +If FACE is non-nil, propertize returned string with this FACE." + (let ((str (cond + ((stringp val) val) + ((null val) guix-false-string) + ((eq t val) guix-true-string) + ((numberp val) (number-to-string val)) + ((listp val) (mapconcat #'guix-get-string + val guix-list-separator)) + (t (prin1-to-string val))))) + (if face + (propertize str 'face face) + str))) + +(defun guix-get-one-line (str) + "Return one-line string from a multi-line STR." + (replace-regexp-in-string "\n" " " str)) + +(defun guix-mapinsert (function sequence separator) + "Like `mapconcat' but for inserting text. +Apply FUNCTION to each element of SEQUENCE, and insert SEPARATOR +at point between each FUNCTION call." + (funcall function (car sequence)) + (mapc (lambda (obj) + (insert separator) + (funcall function obj)) + (cdr sequence))) + +(provide 'guix-utils) + +;;; guix-utils.el ends here diff --git a/guix.el b/guix.el new file mode 100644 index 0000000..01a3183 --- /dev/null +++ b/guix.el @@ -0,0 +1,96 @@ +;;; guix.el --- Interface for GNU Guix package manager + +;; Copyright © 2014 Alex Kost + +;; Author: Alex Kost +;; Version: 0.01 +;; Package-Requires: ((geiser "0.3")) +;; URL: https://github.com/alezost/guix.el +;; Keywords: tools + +;; 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 . + +;;; Commentary: + +;; This package is under development. The goal is to make a +;; full-featured Emacs interface for Guix package manager +;; . + +;; Currently the package provides an interface for searching, listing +;; and getting information about Guix packages. + +;; To install this package, add the following to your init-file: +;; +;; (add-to-list 'load-path "/path/to/guix-dir") +;; (autoload 'guix-search-by-name "guix" nil t) +;; (autoload 'guix-search-by-regexp "guix" nil t) +;; (autoload 'guix-all-available-packages "guix" nil t) +;; (autoload 'guix-newest-available-packages "guix" nil t) + +;;; Code: + +(require 'guix-list) + +(defgroup guix nil + "Interface for Guix package manager." + :prefix "guix-" + :group 'external) + +(defvar guix-search-params '(name synopsis description) + "Default list of parameters for searching by regexp. +Parameters are symbols from `guix-param-alist'.") + +(defvar guix-search-history nil + "A history of minibuffer prompts.") + +;;;###autoload +(defun guix-search-by-name (name) + "Search for Guix packages by NAME. +NAME is a string with name specification. It may optionally contain +a version number. Examples: \"guile\", \"guile-2.0.11\"." + (interactive + (list (read-string "Package name: " nil 'guix-search-history))) + (guix-list-get-show-packages 'name name)) + +;;;###autoload +(defun guix-search-by-regexp (regexp &rest params) + "Search for Guix packages by REGEXP. +PARAMS are package parameters that should be searched. +If PARAMS are not specified, use `guix-search-params'." + (interactive + (list (read-string "Regexp: " nil 'guix-search-history))) + (or params (setq params guix-search-params)) + (guix-list-get-show-packages 'regexp regexp params)) + +;; ;;;###autoload +;; (defun guix-installed-packages () +;; "Display information about installed Guix packages." +;; (interactive) +;; (guix-list-get-show-packages 'installed)) + +;;;###autoload +(defun guix-all-available-packages () + "Display information about all available Guix packages." + (interactive) + (guix-list-get-show-packages 'all-available)) + +;;;###autoload +(defun guix-newest-available-packages () + "Display information about the newest available Guix packages." + (interactive) + (guix-list-get-show-packages 'newest-available)) + +(provide 'guix) + +;;; guix.el ends here