diff options
| -rw-r--r-- | .dir-locals.el | 4 | ||||
| -rw-r--r-- | .ert-runner | 1 | ||||
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | .travis.yml | 50 | ||||
| -rw-r--r-- | Cask | 11 | ||||
| -rw-r--r-- | Changelog.org | 9 | ||||
| -rw-r--r-- | LICENSE | 619 | ||||
| -rw-r--r-- | README.org | 63 | ||||
| -rw-r--r-- | linux-gui-restart-test.sh | 101 | ||||
| -rw-r--r-- | restart-emacs.el | 159 | ||||
| -rw-r--r-- | test/restart-emacs-test.el | 123 | ||||
| -rw-r--r-- | test/test-helper.el | 20 |
12 files changed, 1161 insertions, 0 deletions
diff --git a/.dir-locals.el b/.dir-locals.el new file mode 100644 index 0000000..6c402ec --- /dev/null +++ b/.dir-locals.el @@ -0,0 +1,4 @@ +((emacs-lisp-mode + (compile-command . "cask exec ert-runner") + (eval ignore-errors + (push (quote ("Tests" "(\\(\\<ert-deftest\\)\\>\\s *\\(\\(?:\\sw\\|\\s_\\)+\\)?" 2)) imenu-generic-expression)))) diff --git a/.ert-runner b/.ert-runner new file mode 100644 index 0000000..5b9beb1 --- /dev/null +++ b/.ert-runner @@ -0,0 +1 @@ +--reporter ert
\ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..28f0a7d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.cask/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..1206e1a --- /dev/null +++ b/.travis.yml @@ -0,0 +1,50 @@ +language: emacs-lisp +sudo: false +env: + - EVM_EMACS=emacs-24.5 + - EVM_EMACS=emacs-24.4 + - EVM_EMACS=emacs-24.3 + - EVM_EMACS=emacs-24.2 + - EVM_EMACS=emacs-24.1 + +cache: + apt: true + directories: + - $HOME/emacsen + +addons: + apt: + packages: + - python + - curl + - libxpm-dev + - texinfo + - x11-utils + - xdotool + +before_install: + - "export DISPLAY=:99.0" + - "sh -e /etc/init.d/xvfb start" + - sleep 3 + - curl -fsSkL https://raw.github.com/rejeep/evm/master/go | bash + - export PATH="$HOME/.evm/bin:$PATH" + - mkdir -p $HOME/emacsen + - evm config path $HOME/emacsen + +install: + - evm install $EVM_EMACS --skip + - evm use $EVM_EMACS + - curl -fsSL https://raw.githubusercontent.com/cask/cask/master/go | python + - export PATH="/home/travis/.cask/bin:$PATH" + - cask install + +script: + - cask exec ert-runner + - sh linux-gui-restart-test.sh + +notifications: + email: + recipients: + - iqbalansari02@yahoo.com + on_success: never + on_failure: always
\ No newline at end of file @@ -0,0 +1,11 @@ +(source gnu) +(source melpa) + +(package-file "restart-emacs.el") +(files "*.el") + +(development + (depends-on "f") + (depends-on "ecukes") + (depends-on "ert-runner") + (depends-on "el-mock")) diff --git a/Changelog.org b/Changelog.org new file mode 100644 index 0000000..2cf4e9e --- /dev/null +++ b/Changelog.org @@ -0,0 +1,9 @@ +* v0.1.1 + Bugfix release fixing issues on Emacs versions older than v24.3 (and greater + than v24.1) +** Do not wait for output from new instance of Emacs spawned in parent Emacs +** Signals `error` instead of `user-error` if the later is not available (Emacs older than v24.3) +** Add tests + +* v0.1 + Initial public release @@ -0,0 +1,619 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. diff --git a/README.org b/README.org new file mode 100644 index 0000000..437db91 --- /dev/null +++ b/README.org @@ -0,0 +1,63 @@ +* Restart Emacs + + [[http://melpa.org/#/restart-emacs][file:http://melpa.org/packages/restart-emacs-badge.svg]] [[http://stable.melpa.org/#/restart-emacs][file:http://stable.melpa.org/packages/restart-emacs-badge.svg]] [[https://travis-ci.org/iqbalansari/restart-emacs][https://travis-ci.org/iqbalansari/restart-emacs.svg?branch=master]] + + +** Table of contents :TOC_3_gh: + - [[#restart-emacs][Restart Emacs]] + - [[#what-is-this][What is this?]] + - [[#installation][Installation]] + - [[#elpa][ELPA]] + - [[#el-get][El-get]] + - [[#usage][Usage]] + - [[#compatibility][Compatibility]] + - [[#restarting-gui-emacs][Restarting GUI Emacs]] + - [[#restarting-emacs-running-in-a-terminal][Restarting Emacs running in a terminal]] + +** What is this? + This is a simple package to restart Emacs for within Emacs. Inspired by [[http://emacs.stackexchange.com/questions/5428/restart-emacs-from-within-emacs][this]] + stackoverflow question. + +** Installation +*** ELPA + ~restart-emacs~ is available on [[http://melpa.org/#/restart-emacs][MELPA]] and [[http://stable.melpa.org/#/restart-emacs][MELPA Stable]]. Please follow the instructions on + MELPA [[http://melpa.org/#/getting-started][website]] to enable it, if you haven't already. + + You can then install ~restart-emacs~ from the [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Menu.html][package menu]]. Alternatively install it by doing the following + + Refresh the package index + #+BEGIN_QUOTE + M-x package-refresh-contents RET + #+END_QUOTE + + And then install it by doing + #+BEGIN_QUOTE + M-x package-install RET restart-emacs + #+END_QUOTE + +*** El-get + ~restart-emacs~ can also be installed using ~el-get~. Assuming you have latest version of el-get installing it by doing something similar to + #+BEGIN_QUOTE + M-x el-get-install RET restart-emacs + #+END_QUOTE + +** Usage + It offers only one command ~restart-emacs~ which kills current Emacs session + and starts a new session. + + Additional arguments to be passed to the new instance can be specified using + prefix arguments + + - with a single ~universal-argument~ (=C-u=) Emacs is restarted with ~--debug-init~ flag + - with two ~universal-argument~ (=C-u= =C-u=) Emacs is restarted with ~-Q~ flag + - with three ~universal-argument~ (=C-u= =C-u= =C-u=) the user is prompted for the arguments + +** Compatibility +*** Restarting GUI Emacs + Restarting graphical Emacs should work on any UNIXy system with ~sh~ and on + Windows. + +*** Restarting Emacs running in a terminal + This requires that the shell from which Emacs was launched supports job + control. This has been tested to work on ~sh~, ~bash~, ~zsh~, ~fish~, ~csh~ + and ~tcsh~, however this does not work on Windows. diff --git a/linux-gui-restart-test.sh b/linux-gui-restart-test.sh new file mode 100644 index 0000000..f1a5b56 --- /dev/null +++ b/linux-gui-restart-test.sh @@ -0,0 +1,101 @@ +#!/bin/sh + +# This scripts tests that Emacs restarts successfully under X +# It requires the following utilities installed +# xprop - Available in x11-utils package on Ubuntu +# xwininfo - Available in x11-utils package on Ubuntu +# xdotool - Available in xdotool package on Ubuntu + +if [ -z "$DISPLAY" ] ; then + echo "This script works only under X!" + echo "Exiting ..." + exit 2 +fi + +if [ -z $(which xprop 2> /dev/null) ] || [ -z $(which xwininfo 2> /dev/null) ] || [ -z $(which xdotool 2> /dev/null) ] ; then + echo "This script requires xprop, xwininfo and xdotool to work." + echo "If you are on Ubuntu, please install x11-utils and xdotools packages to get these tools." + echo "Exiting ..." + exit 2 +fi + + +poll_emacs_started () { + for i in $(seq 1 10) ; do + echo "Checking if Emacs started ... " + + if xwininfo -name $EMACS_WIN_NAME > /dev/null 2>&1 ; then + echo "Emacs has started ... " + return 0 + + elif [ $i = 10 ] ; then + echo "Giving up after 10 tries ... " + return 1 + + fi + + echo "Emacs hasn't started yet! Will try again in 5 seconds ... " + sleep 5 + done + +} + +# So that user config does not interfere with functioning of test Emacs +HOME=/tmp + +SUCCESS=1 + +# Name that should be given Emacs window, makes easier to search for window +EMACS_WIN_NAME=restart-emacs-test + +# Setup things so that Emacs window is renamed appropriately after starting +mkdir -p /tmp/.emacs.d/ +printf "(modify-frame-parameters nil (list (cons 'name \"$EMACS_WIN_NAME\")))" > /tmp/.emacs.d/init.el + +# Launch Emacs +cask exec emacs -l restart-emacs.el > /dev/null 2>&1 & + +if poll_emacs_started ; then + EMACS_WINDOW_ID=$(xwininfo -name $EMACS_WIN_NAME | grep 'Window id:' | awk -F' ' '{print $4}') + ORIG_EMACS_PID=$(xprop -name $EMACS_WIN_NAME | grep PID | awk -F' = ' '{print $2}') + + echo "Found Emacs running with window id $EMACS_WINDOW_ID and pid $ORIG_EMACS_PID .. " + + sleep 1 + + echo "Asking Emacs to restart .. " + xdotool search --name $EMACS_WIN_NAME key alt+x + sleep 1 + xdotool search --name $EMACS_WIN_NAME type 'restart-emacs' + sleep 1 + xdotool search --name $EMACS_WIN_NAME key Return + + + sleep 5 + + if poll_emacs_started ; then + RESTARTED_EMACS_PID=$(xprop -name $EMACS_WIN_NAME | grep PID | awk -F' = ' '{print $2}') + + if [ $ORIG_EMACS_PID != $RESTARTED_EMACS_PID ] ; then + echo "Successfully restarted Emacs!" + echo "Test PASSED" + SUCCESS=0 + else + echo "The original Emacs was not killed properly!" + echo "Test FAILED" + fi + + else + echo "Could not restart Emacs, after killing original one!" + echo "Test FAILED" + fi + +else + echo "Could start Emacs, please check for errros and try again!" + SUCCESS=2 +fi + +# Cleanup +xdotool search --name $EMACS_WIN_NAME key ctrl+x +xdotool search --name $EMACS_WIN_NAME key ctrl+c +exit $SUCCESS diff --git a/restart-emacs.el b/restart-emacs.el new file mode 100644 index 0000000..c5e4f8d --- /dev/null +++ b/restart-emacs.el @@ -0,0 +1,159 @@ +;;; restart-emacs.el --- Restart emacs from within emacs -*- lexical-binding: t; -*- + +;; Copyright (C) 2015 Iqbal Ansari + +;; Author: Iqbal Ansari <iqbalansari02@yahoo.com> +;; Keywords: convenience +;; URL: https://github.com/iqbalansari/restart-emacs +;; Version: 0.1.1 + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see <http://www.gnu.org/licenses/>. + +;;; Commentary: + +;; This package provides a simple command to restart Emacs from within Emacs + + + +;;; Code: + +;; Making the byte compiler happy +(declare-function w32-shell-execute "w32fns.c") + + + +;; Compatibility functions + +(defun restart-emacs--string-join (strings &optional separator) + "Join all STRINGS using SEPARATOR. + +This function is available on Emacs v24.4 and higher, it has been +backported here for compatibility with older Emacsen." + (if (fboundp 'string-join) + (apply #'string-join (list strings separator)) + (mapconcat 'identity strings separator))) + +(defun restart-emacs--user-error (format &rest args) + "Signal a `user-error' if available otherwise signal a generic `error'. + +FORMAT and ARGS correspond to STRING and OBJECTS arguments to `format'." + (if (fboundp 'user-error) + (apply #'user-error format args) + (apply #'error format args))) + + + +;; Core functions + +(defvar restart-emacs--args nil + "The arguments with which to restart Emacs is bound dynamically.") + +(defun restart-emacs--get-emacs-binary () + "Get absolute path to binary of currently running Emacs." + (expand-file-name invocation-name invocation-directory)) + +(defun restart-emacs--start-gui-using-sh (&optional args) + "Start GUI version of Emacs using sh. + +ARGS is the list arguments with which Emacs should be started" + (call-process "sh" nil + 0 nil + "-c" (format "%s %s &" + (shell-quote-argument (restart-emacs--get-emacs-binary)) + (restart-emacs--string-join (mapcar #'shell-quote-argument + args) + " ")))) + +(defun restart-emacs--start-gui-on-windows (&optional args) + "Start GUI version of Emacs on windows. + +ARGS is the list arguments with which Emacs should be started" + (w32-shell-execute "open" (restart-emacs--get-emacs-binary) args)) + +(defun restart-emacs--start-emacs-in-terminal (&optional args) + "Start Emacs in current terminal. + +ARGS is the list arguments with which Emacs should be started. This requires a +shell with `fg' command and `;' construct. This has been tested to work with +sh, bash, zsh, fish, csh and tcsh shells" + (suspend-emacs (format "fg ; %s %s -nw" + (shell-quote-argument (restart-emacs--get-emacs-binary)) + (restart-emacs--string-join (mapcar #'shell-quote-argument + args) + " ")))) + +(defun restart-emacs--ensure-can-restart () + "Ensure we can restart Emacs on current platform." + (when (and (not (display-graphic-p)) + (memq system-type '(windows-nt ms-dos))) + (restart-emacs--user-error (format "Cannot restart emacs running in terminal on system of type `%s'" system-type)))) + +(defun restart-emacs--launch-other-emacs () + "Launch another Emacs session according to current platform." + (apply (if (display-graphic-p) + (if (memq system-type '(windows-nt ms-dos)) + #'restart-emacs--start-gui-on-windows + #'restart-emacs--start-gui-using-sh) + (if (memq system-type '(windows-nt ms-dos)) + ;; This should not happen since we check this before triggering a restart + (restart-emacs--user-error "Cannot restart Emacs running in a windows terminal") + #'restart-emacs--start-emacs-in-terminal)) + ;; Since this function is called in `kill-emacs-hook' it cannot accept + ;; direct arguments the arguments are let-bound instead + (list restart-emacs--args))) + +(defun restart-emacs--translate-prefix-to-args (prefix) + "Translate the given PREFIX to arguments to be passed to Emacs. + +It does the following translation + `C-u' => --debug-init + `C-u' `C-u' => -Q +`C-u' `C-u' `C-u' => Reads the argument from the user in raw form" + (cond ((equal prefix '(4)) '("--debug-init")) + ((equal prefix '(16)) '("-Q")) + ((equal prefix '(64)) (split-string (read-string "Arguments to start Emacs with (separated by space): ") + " ")))) + + + +;; User interface + +;;;###autoload +(defun restart-emacs (&optional args) + "Restart Emacs. + +When called interactively ARGS is interpreted as follows + +- with a single `universal-argument' (`C-u') Emacs is restarted + with `--debug-init' flag +- with two `universal-argument' (`C-u') Emacs is restarted with + `-Q' flag +- with three `universal-argument' (`C-u') the user prompted for + the arguments + +When called non-interactively ARGS should be a list of arguments +with which Emacs should be restarted." + (interactive "P") + ;; Do not trigger a restart unless we are sure, we can restart emacs + (restart-emacs--ensure-can-restart) + ;; We need the new emacs to be spawned after all kill-emacs-hooks + ;; have been processed and there is nothing interesting left + (let ((kill-emacs-hook (append kill-emacs-hook (list #'restart-emacs--launch-other-emacs))) + (restart-emacs--args (if (called-interactively-p 'any) + (restart-emacs--translate-prefix-to-args args) + args))) + (save-buffers-kill-emacs))) + +(provide 'restart-emacs) +;;; restart-emacs.el ends here diff --git a/test/restart-emacs-test.el b/test/restart-emacs-test.el new file mode 100644 index 0000000..02d0115 --- /dev/null +++ b/test/restart-emacs-test.el @@ -0,0 +1,123 @@ +;;; restart-emacs-test.el --- Tests for restart-emacs -*- lexical-binding: t; -*- + +;;; Commentary: +;;; Tests for restart-emacs, major use case is to run from the command-line +;;; using `cask exec ert-runner' but can be run interactively as well. Do +;;; M-x `eval-buffer' RET + +;;; Code: + +;; For interactive testing +(unless noninteractive + (load (expand-file-name "test-helper.el") t)) + +(require 'restart-emacs) + +(require 'ert) +(require 'el-mock) +;; el-mock requires this +(require 'cl) + +(require 'cl-lib) + +(ert-deftest restart-emacs-test-prefix-translation () + (with-mock + (stub read-string => "read string") + (should (equal (restart-emacs--translate-prefix-to-args '(4)) '("--debug-init"))) + (should (equal (restart-emacs--translate-prefix-to-args '(16)) '("-Q"))) + (should (equal (restart-emacs--translate-prefix-to-args '(64)) '("read" "string"))))) + +(ert-deftest restart-emacs-test-restart-capability () + (with-mock + (stub display-graphic-p => nil) + ;; `signal' tries to use this (and fails) if `system-type' is `windows-nt', + ;; stub it out + (stub w32-long-file-name => "/tmp") + (let ((system-type 'windows-nt)) + (should-error (restart-emacs--ensure-can-restart) :type (if (version<= "24.3" emacs-version) + 'user-error + 'error))) + + (let ((system-type 'ms-dos)) + (should-error (restart-emacs--ensure-can-restart) :type (if (version<= "24.3" emacs-version) + 'user-error + 'error)))) + + (with-mock + (stub display-graphic-p => t) + (let ((system-type 'windows-nt)) + (should-not (restart-emacs--ensure-can-restart))) + + (let ((system-type 'ms-dos)) + (should-not (restart-emacs--ensure-can-restart))))) + +(ert-deftest restart-emacs-test-path-calculation () + (let ((invocation-name "emacs") + (invocation-directory "/tmp/test/")) + (should (string= (restart-emacs--get-emacs-binary) "/tmp/test/emacs")))) + +(ert-deftest restart-emacs-test-gui-using-sh () + (with-mock + (stub restart-emacs--get-emacs-binary => "/tmp/bin/emacs") + (mock (call-process "sh" nil + 0 nil + "-c" "/tmp/bin/emacs --debug-init &")) + (should-not (restart-emacs--start-gui-using-sh '("--debug-init"))))) + +(ert-deftest restart-emacs-test-gui-on-windows () + (with-mock + (stub restart-emacs--get-emacs-binary => "/tmp/bin/emacs") + (mock (w32-shell-execute "open" "/tmp/bin/emacs" '("--debug-init"))) + (should-not (restart-emacs--start-gui-on-windows '("--debug-init"))))) + +(ert-deftest restart-emacs-test-start-emacs-in-terminal () + (with-mock + (stub restart-emacs--get-emacs-binary => "/tmp/bin/emacs") + (mock (suspend-emacs "fg ; /tmp/bin/emacs --debug-init -nw")) + (should-not (restart-emacs--start-emacs-in-terminal '("--debug-init"))))) + +(ert-deftest restart-emacs-test-strategy () + (with-mock + (stub display-graphic-p => nil) + ;; `signal' tries to use this (and fails) if `system-type' is `windows-nt', + ;; stub it out + (stub w32-long-file-name => "/tmp") + (mock (restart-emacs--start-emacs-in-terminal nil) :times 5) + (dolist (system '(gnu gnu/linux gnu/kfreebsd darwin cygwin)) + (let ((system-type system)) + (should-not (restart-emacs--launch-other-emacs)))) + + (dolist (system '(windows-nt ms-dos)) + (let ((system-type system)) + (should-error (restart-emacs--launch-other-emacs) :type (if (version<= "24.3" emacs-version) + 'user-error + 'error))))) + + (with-mock + (stub display-graphic-p => t) + (mock (restart-emacs--start-gui-using-sh nil) :times 5) + (mock (restart-emacs--start-gui-on-windows nil) :times 2) + (dolist (system '(gnu gnu/linux gnu/kfreebsd darwin cygwin)) + (let ((system-type system)) + (should-not (restart-emacs--launch-other-emacs)))) + + (dolist (system '(windows-nt ms-dos)) + (let ((system-type system)) + (should-not (restart-emacs--launch-other-emacs)))))) + +(ert-deftest restart-emacs-test-restart-setup () + (cl-letf (((symbol-function 'save-buffers-kill-emacs) + (lambda nil + (should (equal (cl-position #'restart-emacs--launch-other-emacs kill-emacs-hook) + (1- (length kill-emacs-hook))))))) + + (restart-emacs) + ;; Make sure that hook to restart emacs is removed after the function + ;; restart-emacs exits + (should-not (cl-find #'restart-emacs--launch-other-emacs kill-emacs-hook)))) + +(unless noninteractive + (ert "^restart-emacs-")) + +(provide 'restart-emacs-test) +;;; restart-emacs-test.el ends here diff --git a/test/test-helper.el b/test/test-helper.el new file mode 100644 index 0000000..606e75a --- /dev/null +++ b/test/test-helper.el @@ -0,0 +1,20 @@ +;;; test-helper.el --- Tests for restart-emacs -*- lexical-binding: t; -*- + +;;; Commentary: +;;; Helpers to write tests for restart-emacs + +;;; Code: + +;; Setup load-path, some of this is redundant when tests are run from the +;; command line +(let ((project-dir (locate-dominating-file (or (buffer-file-name) load-file-name) + ".cask"))) + (if (not project-dir) + (user-error "Could not locate project root") + (let ((default-directory (expand-file-name (concat ".cask/" emacs-version) project-dir))) + (normal-top-level-add-subdirs-to-load-path)) + + (add-to-list 'load-path project-dir))) + +(provide 'test-helper) +;;; test-helper.el ends here |