├── .github
└── workflows
│ └── test.yml
├── .gitignore
├── LICENSE
├── Makefile
├── README.org
├── ppcompile.el
├── test
├── authinfo.txt
├── hello-world-project
│ ├── .dir-locals.el
│ ├── Makefile
│ └── hello-world.c
├── id_ppcompile_test
├── id_ppcompile_test.pub
└── ppcompile-test.el
└── with-password.exp
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
1 | name: CI
2 |
3 | on: [push, pull_request]
4 |
5 | jobs:
6 | build:
7 | runs-on: ubuntu-latest
8 | strategy:
9 | matrix:
10 | emacs_version:
11 | - 25.1
12 | - 25.3
13 | - 26.1
14 | - 26.3
15 | - snapshot
16 | steps:
17 | - uses: purcell/setup-emacs@master
18 | with:
19 | version: ${{ matrix.emacs_version }}
20 |
21 | - uses: actions/checkout@v1
22 | - name: Run tests
23 | run: |
24 | make clean && make test
25 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.elc
2 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | EMACS ?= emacs
2 |
3 | .PHONY: compile checkdoc clean test test-with-sshd
4 |
5 | all: compile checkdoc test
6 |
7 | compile:
8 | $(EMACS) -Q -batch -L . --eval "(setq byte-compile-error-on-warn t)" -f batch-byte-compile ppcompile.el
9 |
10 | # TODO How to make it error out if something goes wrong?
11 | checkdoc:
12 | $(EMACS) -Q -batch --eval '(checkdoc-file "ppcompile.el")'
13 |
14 | test:
15 | $(EMACS) -Q -batch -l ppcompile.el -l test/ppcompile-test.el --eval "(ert-run-tests-batch-and-exit '(not (tag sshd)))"
16 |
17 | test-with-sshd:
18 | $(EMACS) -Q -batch -l ppcompile.el -l test/ppcompile-test.el --eval "(ert-run-tests-batch-and-exit '(tag sshd))"
19 |
20 | clean:
21 | rm -f *.elc
22 |
--------------------------------------------------------------------------------
/README.org:
--------------------------------------------------------------------------------
1 | This Emacs package tries to ease the development workflow that consists of coding locally, compiling remotely, and then fixing errors with =next-error= locally, which is the typical development cycle for C/C++ projects.
2 |
3 | ~M-x ppcompile~ works in 2 steps under the hood, like playing a ping-pong game:
4 | 1. ping: =rsync= current project to a remote machine, compiles it there,
5 | 2. pong: send the compilation result back from the remote machine, convert remote paths in the =*compilation*= output to local paths according to the alist =ppcompile-path-mapping-list=
6 |
7 | Then =compilation-mode= can find the files containing errors or warnings correctly while executing =M-x next-error= and =M-x previous-error=.
8 |
9 | #+begin_src artist
10 |
11 | +---------+ +--------+
12 | | | ping: rsync files | |
13 | | | ---------------------------------------> | |
14 | | local | | remote |
15 | | (Emacs) | <--------------------------------------- | (build)|
16 | | | pong: compile & replace paths | |
17 | +---------+ +--------+
18 |
19 | #+end_src
20 |
21 | The project root is detected via =(project-current)=, if it fails =ppcompile= will take the top-level =git= directory as the project root.
22 |
23 | Currently, it's only tested with GNU Emacs 26.3/27.2 on Linux.
24 |
25 | * Installation
26 |
27 | [[https://melpa.org/#/ppcompile][file:https://melpa.org/packages/ppcompile-badge.svg]]
28 |
29 | ppcompile is now available on [[https://melpa.org/#/ppcompile][melpa]], so you can easily install it by ~M-x package-install RET ppcompile RET~.
30 |
31 | ** Extra Dependencies
32 |
33 | - built-in packages: =compile=, =auth-source=, =project=, and =files-x=
34 | - external programs: =rsync=, =ssh=, =expect=.
35 |
36 | Make sure you have these on your system.
37 |
38 | It will not use =expect= if =expect= isn't available on your system, then SSH public key authentication is mandatory in this case.
39 |
40 | * How to Use
41 |
42 | - =M-x ppcompile-config-project= to configure various settings for a project.
43 |
44 | See details in the section [[*Configurations][Configurations]] below.
45 |
46 | - =M-x ppcompile= to ping-pong compile the current project.
47 |
48 | It rsync's the current project to the remote host, compiles it remotely, takes back the output and converts the remote paths to the local ones, so that =compilation-mode= works perfectly. Or put it in another way, it executes =ppcompile-ping= and =ppcompile-pong= sequentially.
49 |
50 | It respects the =compilation-read-command= variable of =compile=, which means it will give you a chance to edit the compile command if you set it to non-=nil=.
51 |
52 | The input history is kept in =ppcompile--remote-command-history=. Hit ENTER directly and it will use the last compile command. You can also hit =M-n= to get the default compile command (on the remote machine), and hit more =M-n= and =M-p= to navigate the command history.
53 |
54 | - =M-x ppcompile-ping= to rsync the project.
55 | - =M-x ppcompile-pong= to compile the project remotely.
56 |
57 | If you want to change the prompt behavior temporarily, prefix the command, i.e. =C-u M-x ppcompile-pong=.
58 | - =M-x ppcompile-toggle-debug= to toggle debugging.
59 | - =M-x ppcompile-get-ssh-password= to get the password of the current project, if password authentication is used, this command is intended for debugging.
60 |
61 | * Configurations
62 |
63 | There is quite some configurations to set, globally or per project.
64 |
65 | ** Per-project Configurations
66 |
67 | =M-x ppcompile-config-project= will guide you through to set them up in =.dir-locals.el= in the project root. It makes life a little bit easier if you have more than one remote hosts to compile different projects, which often is the case. You can then fine-tune the =.dir-locals.el= file after finishing the command.
68 |
69 | Here is an example of =.dir-locals.el=:
70 | #+begin_src elisp
71 | ;;; Directory Local Variables
72 | ;;; For more information see (info "(emacs) Directory Variables")
73 |
74 | ((nil
75 | (eval . (setq ppcompile-path-mapping-alist
76 | `(("/tmp/" . ,(file-name-directory (directory-file-name (file-name-directory (buffer-file-name))))))))
77 | (ppcompile-remote-compile-command . "make -C .")
78 | (ppcompile-ssh-user . "test")
79 | (ppcompile-ssh-host . "localhost")
80 | (ppcompile-rsync-dst-dir . "/tmp/")))
81 | #+end_src
82 |
83 | The input history is kept in the variable =ppcompile--config-history=, so you can hit =M-n= and =M-p= to get your previous input to save you some effort.
84 |
85 | The configurations covered by the command include:
86 |
87 | - =ppcompile-ssh-host= :: the remote host
88 | - =ppcompile-ssh-port= :: the ssh port of remote host, which defaults to 22
89 | - =ppcompile-ssh-user= :: user name, which defaults to currently logged in user, as returned by =(user-login-name)=
90 | - =ppcompile-rsync-dst-dir= :: remote containing directory for the project
91 | - =ppcompile-remote-compile-command= :: The compile command executed under the remote project directory.
92 | - =ppcompile-path-mapping-list= :: alist for path mapping
93 |
94 | The =car= of each whose element is a remote path, and the =cdr= a local path, all paths should be absolute paths.
95 |
96 | The above configurations may vary from projects to projects, so they are typically set per project.
97 |
98 | ** Global Configurations
99 |
100 | There are also other global configurations, which have defaults:
101 | - =ppcompile-ssh-additional-args= :: additional arguments for the =ssh= command line
102 | - =ppcompile-rsync-additional-args= :: additional arguments for the =rsync= command line
103 | - =ppcompile-rsync-exclude-list= :: a list specifying files you want to exclude, such as binary files.
104 | - =ppcompile-ssh-executable= :: The =ssh= executable
105 | - =ppcompile-rsync-executable= :: The =rsync= executable
106 | - =ppcompile-expect-executable= :: The =expect= executable
107 | - =ppcompile-with-password-script-path= :: The path of the helper expect script =with-password.exp=.
108 |
109 | The default value may be wrong if your =.elc= file isn't in the same directory of the =with-password.exp=, which means the file path doesn't exist, to make SSH public key authentication mandatory.
110 |
111 | ** SSH Credentials
112 | Besides that, you may need to configure your passwords in some =auth-source= backends, for example, one entry for a host in =~/.authinfo= looks like:
113 | #+begin_src
114 | machine localhost port 22 login try password 1
115 | #+end_src
116 |
117 | Also, pay attention to Emacs variable =auth-sources= to include your setting.
118 |
119 | That being said, **public key authentication is recommended** though, whenever it's possible, and keep various configurations including identity files in =~/.ssh/config=. ([[https://whatacold.github.io/2019-12-22-manage-ssh-connections-with-ssh-config.html][Manage SSH connections with =~/.ssh/config=]])
120 |
121 | * Troubleshooting
122 |
123 | After the above settings, chances are that it still doesn't work. You can troubleshoot it by following these steps:
124 |
125 | 1. Turn on debugging by =M-x ppcompile-toggle-debug=
126 |
127 | Re-run it once again, and check out the shell commands in the =*Message*= buffer, and if there is setting wrong. Run the command on a terminal manually, to see if there is more error info.
128 |
129 | 2. Confirm that the password is right by =M-x ppcompile-get-ssh-password= if you're using password authentication for ssh.
130 |
131 | Setting =auth-source= can be tricky, so this may help. Also try ~M-x auth-source-forget-all-cached~ if you just changed your auth-source entries.
132 |
133 | Note that these commands should be executed on the buffers of project files, to take advantage of the configurations for that particular project.
134 |
135 | * Other Solutions
136 |
137 | - [[https://github.com/libfuse/sshfs][sshfs]] mounts the remote FS locally, which would be an option if you have a stable, fast network and want to edit remote files just like locally.
138 |
139 | Note that you still need to compile it on the remote host, though you can edit it within your local environment.
140 |
141 | - [[https://github.com/buildfoundation/mainframer][mainframer]], a tool for remote builds, although not based on Emacs, is a more general solution with a similar idea.
142 |
143 | * Development
144 |
145 | - Run =make test= to test the code
146 |
147 | And =make test-with-sshd= to test the functionality with a sshd server, which requires some additional setup:
148 | 1. Start a ssh server at port 22000: =/usr/sbin/sshd -p 22000=
149 |
150 | 2. Copy the public key file: =ssh-copy-id -p 22000 -i ./test/id_ppcompile_test localhost=
151 | This will append the public key file to =~/.ssh/authorized_keys=, so *don't do this on your publicly available server*, because it will be open to anyone who uses the private key in the =test/= directory to ssh into your server, and do something evil.
152 |
153 | - =make checkdoc= checks the docstrings.
154 | - =make compile= compiles the elisp files.
155 |
156 | * Final words
157 |
158 | This was my first time to roll out a package seriously, I believe there is much to improve, so pull requests and issues are very welcome.
159 |
--------------------------------------------------------------------------------
/ppcompile.el:
--------------------------------------------------------------------------------
1 | ;;; ppcompile.el --- Ping-pong compile projects on remote machines -*- lexical-binding: t -*-
2 |
3 | ;; Author: Guangwang Huang
4 | ;; Maintainer: Guangwang Huang
5 | ;; URL: https://github.com/whatacold/ppcompile
6 | ;; Version: 0.1
7 | ;; Package-Requires: ((emacs "25.1"))
8 | ;; Homepage: https://github.com/whatacold/ppcompile
9 | ;; Keywords: tools
10 |
11 |
12 | ;; This file is not part of GNU Emacs
13 |
14 | ;; This file is free software; you can redistribute it and/or modify
15 | ;; it under the terms of the GNU General Public License as published by
16 | ;; the Free Software Foundation; either version 3, or (at your option)
17 | ;; any later version.
18 |
19 | ;; This program is distributed in the hope that it will be useful,
20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 | ;; GNU General Public License for more details.
23 |
24 | ;; For a full copy of the GNU General Public License
25 | ;; see .
26 |
27 |
28 | ;;; Commentary:
29 |
30 | ;; This package tries to ease the workflow that consists of coding locally,
31 | ;; compiling remotely, and fixing errors with `next-error' and `previous-error' locally.
32 | ;; It depends on built-in packages: auth-source,
33 | ;; project , files-x and compile.
34 | ;; And it also depends on external programs: rsync, ssh, and expect.
35 |
36 | ;;; Code:
37 |
38 | (require 'compile)
39 | (require 'auth-source)
40 | (require 'project)
41 | (require 'files-x)
42 |
43 | (defgroup ppcompile nil
44 | "Ping pong compile."
45 | :group 'tools)
46 |
47 | (defcustom ppcompile-ssh-executable (if (eq system-type 'windows-nt)
48 | "ssh.exe"
49 | "ssh")
50 | "The ssh executable."
51 | :type 'string
52 | :group 'ppcompile)
53 |
54 | (defcustom ppcompile-rsync-executable (if (eq system-type 'windows-nt)
55 | "rsync.exe"
56 | "rsync")
57 | "The rsync executable."
58 | :type 'string
59 | :group 'ppcompile)
60 |
61 | (defcustom ppcompile-expect-executable (if (eq system-type 'windows-nt)
62 | "expect.exe"
63 | "expect")
64 | "The expect executable."
65 | :type 'string
66 | :group 'ppcompile)
67 |
68 | (defcustom ppcompile-with-password-script-path
69 | (concat (file-name-directory (or load-file-name buffer-file-name))
70 | "with-password.exp")
71 | "The path of the helper expect script `with-password.exp'."
72 | :type 'string
73 | :group 'ppcompile)
74 |
75 | (defcustom ppcompile-ssh-host nil
76 | "Host of the remote machine, where remote compilation runs."
77 | :type 'string
78 | :group 'ppcompile)
79 |
80 | (defcustom ppcompile-ssh-port 22
81 | "SSH port of the remote machine."
82 | :type 'integer
83 | :group 'ppcompile)
84 |
85 | (defcustom ppcompile-ssh-user (user-login-name)
86 | "SSH user to login for remote compilations."
87 | :type 'string
88 | :group 'ppcompile)
89 |
90 | (defcustom ppcompile-ssh-additional-args ""
91 | "Additional arguments for `ssh'."
92 | :type 'string
93 | :group 'ppcompile)
94 |
95 | (defcustom ppcompile-rsync-exclude-list '("*.o"
96 | ".git*"
97 | ".svn*")
98 | "Files that `rsync' should exclude.
99 | See `--exclude' option of `rsync' for the syntax."
100 | :type '(repeat string)
101 | :group 'ppcompile)
102 |
103 | (defcustom ppcompile-rsync-additional-args "-az"
104 | "Arguments for `rsync', in addition to `ppcompile-rsync-exclude-list'.
105 | Do not contain spaces in the value."
106 | :type 'string
107 | :group 'ppcompile)
108 |
109 | (defcustom ppcompile-rsync-dst-dir nil
110 | "The destination containing directory to `rsync' files into."
111 | :type 'string
112 | :group 'ppcompile)
113 |
114 | (defcustom ppcompile-remote-compile-command "make -k -C ."
115 | "The default compile command executed on remote.
116 |
117 | The command will be executed under the remote project directory.
118 |
119 | You should specify the `-C' argument if it's `make', which makes `make'
120 | print things like \"make: Entering directory '/tmp/hello-world-project'\",
121 | so as to make ppcompile convert the remote paths correctly."
122 | :type 'string
123 | :group 'ppcompile)
124 |
125 | (defcustom ppcompile-path-mapping-alist nil
126 | "A list of `cons' cells tells how to map remote paths to local paths.
127 | Each cons cell's key is remote path, and value is local path, all paths
128 | should be in absolute path."
129 | :type '(alist :key-type string :value-type string)
130 | :group 'ppcompile)
131 |
132 | (defvar ppcompile--current-buffer nil
133 | "The current buffer before compiling.
134 |
135 | Used to fetch its buffer-local variables.")
136 |
137 | (defvar ppcompile--debug nil
138 | "If non-nil, log additional messages while using.")
139 |
140 | (defvar ppcompile--config-history nil
141 | "History list of user configuration input.")
142 |
143 | (defvar ppcompile--remote-command-history nil
144 | "History list of the user's remote commands.")
145 |
146 | (defun ppcompile--expect-available-p ()
147 | "Predicate whether `expect' and the helper script are both available."
148 | (and (file-exists-p ppcompile-with-password-script-path)
149 | (file-executable-p (or (executable-find ppcompile-expect-executable)
150 | ppcompile-expect-executable))))
151 |
152 | (defun ppcompile--replace-path (buffer _finish-msg)
153 | "Replace paths in BUFFER, according to `ppcompile-path-mapping-alist'.
154 | Argument _FINISH-MSG is a string describing how the process finished."
155 | (let ((path-mapping-list (with-current-buffer ppcompile--current-buffer
156 | ppcompile-path-mapping-alist)))
157 | (with-current-buffer buffer
158 | (let ((inhibit-read-only t)
159 | from to)
160 | (dolist (map path-mapping-list)
161 | ;; ensure both `from' & `to' ending with /
162 | (setq from (car map))
163 | (when (/= ?/ (aref from (1- (length from))))
164 | (setq from (concat from "/")))
165 | (setq to (cdr map))
166 | (when (/= ?/ (aref to (1- (length to))))
167 | (setq to (concat to "/")))
168 | (goto-char (point-min))
169 | (while (search-forward from nil t)
170 | (replace-match to)))))))
171 |
172 | (defun ppcompile--project-root ()
173 | "Find the root directory of current project.
174 |
175 | If `project-current' finds the root, return it;
176 | or else fallback to use `git' root directory containing `.git'."
177 | (or (cdr (project-current))
178 | (locate-dominating-file default-directory (lambda (dir)
179 | (file-directory-p (expand-file-name ".git" dir))))
180 | default-directory))
181 |
182 | ;;;###autoload
183 | (defun ppcompile-ping ()
184 | "Rsync current project from local machine to remote one.
185 |
186 | Return the command exit status and its output as a cons."
187 | (interactive)
188 | (let* ((default-directory (ppcompile--project-root))
189 | (project-path (expand-file-name default-directory))
190 | (expect-available-p (ppcompile--expect-available-p))
191 | (process-environment process-environment)
192 | (rsync-status 1)
193 | (ping-args (mapcar (lambda (pattern) (format "--exclude=%s" pattern))
194 | ppcompile-rsync-exclude-list))
195 | ping-output)
196 | (push (format "--rsh=%s -p %d %s"
197 | ppcompile-ssh-executable
198 | ppcompile-ssh-port
199 | ppcompile-ssh-additional-args)
200 | ping-args)
201 | (when ppcompile-rsync-additional-args
202 | (push ppcompile-rsync-additional-args ping-args))
203 |
204 | ;; a trailing slash makes a difference for rsync, trim it if any.
205 | (when (equal (substring project-path
206 | (1- (length project-path))) "/" )
207 | (setq project-path (substring project-path 0 (1- (length project-path)))))
208 | (push project-path ping-args)
209 |
210 | (push (format "%s@%s:%s"
211 | ppcompile-ssh-user
212 | ppcompile-ssh-host
213 | ppcompile-rsync-dst-dir)
214 | ping-args)
215 | (setq ping-args (nreverse ping-args))
216 |
217 | (when ppcompile--debug
218 | (if (not expect-available-p)
219 | (message "ppcompile ping command: %s %s"
220 | ppcompile-rsync-executable
221 | (mapconcat (lambda (arg) (format "'%s'" arg))
222 | ping-args " "))
223 | (message "ppcompile ping command: %s %s %s %s"
224 | ppcompile-expect-executable
225 | ppcompile-with-password-script-path
226 | ppcompile-rsync-executable
227 | (mapconcat (lambda (arg) (format "'%s'" arg))
228 | ping-args " "))
229 | (setq process-environment (cons (format "PPCOMPILE_PASSWORD=%s"
230 | (ppcompile-get-ssh-password))
231 | process-environment))))
232 |
233 | (save-some-buffers)
234 | (with-temp-buffer
235 | (setq rsync-status (if expect-available-p (apply #'call-process
236 | ppcompile-expect-executable
237 | nil
238 | (current-buffer)
239 | nil
240 | ppcompile-with-password-script-path
241 | ppcompile-rsync-executable
242 | ping-args)
243 | (apply #'call-process
244 | ppcompile-rsync-executable
245 | nil
246 | (current-buffer)
247 | nil
248 | ping-args)))
249 | (setq ping-output (buffer-substring-no-properties (point-min) (point-max))))
250 | (cons rsync-status ping-output)))
251 |
252 | (defun ppcompile-pong (flip-pong-prompt-p)
253 | "Compile the project remotely.
254 |
255 | And replace remote paths with local ones in the *compilation* buffer,
256 | So that \\[next-error] and \\[previous-error] work correctly.
257 |
258 | If FLIP-PONG-PROMPT-P is not nil, it flips the value of variable
259 | `compilation-read-command' when executing this function."
260 | (interactive "P")
261 | (let* ((default-directory (ppcompile--project-root))
262 | (compilation-environment compilation-environment)
263 | (expect-available-p (ppcompile--expect-available-p))
264 | (compilation-read-command (if flip-pong-prompt-p
265 | (not compilation-read-command)
266 | compilation-read-command))
267 | (remote-compile-command ppcompile-remote-compile-command)
268 | (project-basename (file-name-nondirectory
269 | (directory-file-name
270 | (ppcompile--project-root))))
271 | (user-prompt-command-initial (if (> (length ppcompile--remote-command-history) 0)
272 | (car ppcompile--remote-command-history)
273 | ppcompile-remote-compile-command))
274 | pong-command)
275 | (setq ppcompile--current-buffer (current-buffer))
276 | (add-to-list 'compilation-finish-functions #'ppcompile--replace-path) ; XXX how to do this elegantly?
277 |
278 | (when compilation-read-command
279 | (setq remote-compile-command (read-from-minibuffer
280 | (format "[ppcompile] on remote dir \"%s/%s\": "
281 | ppcompile-rsync-dst-dir
282 | project-basename)
283 | user-prompt-command-initial
284 | nil
285 | nil
286 | 'ppcompile--remote-command-history
287 | user-prompt-command-initial))
288 | (when (string-equal "" remote-compile-command)
289 | (setq remote-compile-command user-prompt-command-initial)))
290 |
291 | (if (not expect-available-p)
292 | (setq pong-command (format "%s -p %d %s %s@%s 'cd %s/%s && %s'"
293 | ppcompile-ssh-executable
294 | ppcompile-ssh-port
295 | ppcompile-ssh-additional-args
296 | ppcompile-ssh-user
297 | ppcompile-ssh-host
298 | ppcompile-rsync-dst-dir
299 | project-basename
300 | remote-compile-command))
301 | (setq compilation-environment (cons (format "PPCOMPILE_PASSWORD=%s"
302 | (ppcompile-get-ssh-password))
303 | compilation-environment))
304 | (setq pong-command (format "%s %s %s -p %d %s %s@%s 'cd %s/%s && %s'"
305 | ppcompile-expect-executable
306 | ppcompile-with-password-script-path
307 | ppcompile-ssh-executable
308 | ppcompile-ssh-port
309 | ppcompile-ssh-additional-args
310 | ppcompile-ssh-user
311 | ppcompile-ssh-host
312 | ppcompile-rsync-dst-dir
313 | project-basename
314 | remote-compile-command)))
315 |
316 | (when ppcompile--debug
317 | (message "ppcompile pong command: %s" pong-command))
318 | (compilation-start pong-command)
319 |
320 | (with-current-buffer "*compilation*"
321 | (hack-dir-local-variables-non-file-buffer))))
322 |
323 | ;;;###autoload
324 | (defun ppcompile (&optional flip-pong-prompt-p)
325 | "Ping-pong compile current project.
326 |
327 | If FLIP-PONG-PROMPT-P is not nil, it flips the value of variable
328 | `compilation-read-command' when executing this function."
329 | (interactive "P")
330 | (let* ((rsync-result (ppcompile-ping)))
331 | (if (not (eq 0 (car rsync-result)))
332 | (message "Failed to rsync current project, rsync output is: %s" (cdr rsync-result))
333 | (ppcompile-pong flip-pong-prompt-p))))
334 |
335 | ;;;###autoload
336 | (defun ppcompile-toggle-debug ()
337 | "Toggle debugging."
338 | (interactive)
339 | (setq ppcompile--debug (not ppcompile--debug))
340 | (message "ppcompile debug %s" (if ppcompile--debug
341 | "on"
342 | "off")))
343 |
344 | ;;;###autoload
345 | (defun ppcompile-get-ssh-password (&optional interactive-p)
346 | "Get SSH password using auth-source if `INTERACTIVE-P' is non nil.
347 |
348 | nil returned if no password configured."
349 | (interactive "p")
350 | (let ((secret
351 | (plist-get
352 | (nth 0
353 | (auth-source-search :max 1
354 | :host ppcompile-ssh-host
355 | :user ppcompile-ssh-user
356 | ;; secrets.el wouldn’t accept a number
357 | :port (if (numberp ppcompile-ssh-port)
358 | (number-to-string ppcompile-ssh-port)
359 | ppcompile-ssh-port)
360 | :require '(:secret)))
361 | :secret)))
362 | (when (functionp secret)
363 | (setq secret (funcall secret)))
364 | (when (not (stringp secret))
365 | (setq secret ""))
366 | (when (and ppcompile--debug (= 0 (length secret)))
367 | (message "No ppcompile password for the current project!"))
368 | (if interactive-p
369 | (message "ppcompile password for the current project: '%s'" secret)
370 | secret)))
371 |
372 | ;;;###autoload
373 | (defun ppcompile-config-project ()
374 | "Guide you to configure variables in `.dir-locals.el' in the project root."
375 | (interactive)
376 | (save-excursion
377 | (let ((default-directory (ppcompile--project-root))
378 | host port user dst-dir remote-compile-command modified-p)
379 | (setq host (read-from-minibuffer "[ppcompile] ssh host: "
380 | nil
381 | nil
382 | nil
383 | 'ppcompile--config-history))
384 | (setq port (string-to-number (read-from-minibuffer "[ppcompile] ssh port: "
385 | nil
386 | nil
387 | nil
388 | 'ppcompile--config-history
389 | "22")))
390 | (setq user (read-from-minibuffer "[ppcompile] ssh user: "
391 | nil
392 | nil
393 | nil
394 | 'ppcompile--config-history))
395 | (setq dst-dir (read-from-minibuffer "[ppcompile] remote containing directory to rsync it: "
396 | nil
397 | nil
398 | nil
399 | 'ppcompile--config-history))
400 | (setq remote-compile-command (read-from-minibuffer "[ppcompile] compile command (`M-n' to get started): "
401 | nil
402 | nil
403 | nil
404 | 'ppcompile--config-history
405 | ppcompile-remote-compile-command))
406 | (when (> (length host) 0)
407 | (setq modified-p t)
408 | (add-dir-local-variable nil 'ppcompile-ssh-host host))
409 | (when (> port 0)
410 | (setq modified-p t)
411 | (add-dir-local-variable nil 'ppcompile-ssh-port port))
412 | (when (> (length user) 0)
413 | (setq modified-p t)
414 | (add-dir-local-variable nil 'ppcompile-ssh-user user))
415 | (when (> (length dst-dir) 0)
416 | (setq modified-p t)
417 | (add-dir-local-variable nil 'ppcompile-rsync-dst-dir dst-dir)
418 |
419 | ;; FIXME The mapping in the .dir-locals.el file may have duplicates
420 | (push (cons dst-dir (expand-file-name (concat default-directory "/../")))
421 | ppcompile-path-mapping-alist)
422 | (add-dir-local-variable nil 'eval `(setq ppcompile-path-mapping-alist
423 | ',ppcompile-path-mapping-alist)))
424 | (when (> (length remote-compile-command) 0)
425 | (setq modified-p t)
426 | (add-dir-local-variable nil 'ppcompile-remote-compile-command remote-compile-command))
427 |
428 | (when modified-p
429 | (when (y-or-n-p (format "Save %s.dir-locals.el? " default-directory))
430 | (save-buffer)
431 | (bury-buffer))))))
432 |
433 | (provide 'ppcompile)
434 |
435 | ;;; ppcompile.el ends here
436 |
--------------------------------------------------------------------------------
/test/authinfo.txt:
--------------------------------------------------------------------------------
1 | machine example.com port 1234 login foobar password "foo:BAR123!"
2 |
--------------------------------------------------------------------------------
/test/hello-world-project/.dir-locals.el:
--------------------------------------------------------------------------------
1 | ;;; Directory Local Variables
2 | ;;; For more information see (info "(emacs) Directory Variables")
3 |
4 | ((nil
5 | (eval setq project-find-functions #'(lambda (dir) (cons 'test dir)))
6 | (ppcompile-remote-compile-command . "make -C . -k")
7 | (eval setq ppcompile-path-mapping-alist
8 | `(("/tmp/" . ,(file-name-directory (directory-file-name default-directory)))))
9 | (ppcompile-rsync-dst-dir . "/tmp/")
10 | (ppcompile-ssh-port . 22000)
11 | (ppcompile-ssh-host . "localhost")
12 | (eval setq ppcompile-ssh-additional-args (format "-i %sid_ppcompile_test" (file-name-directory (directory-file-name default-directory))))))
13 |
--------------------------------------------------------------------------------
/test/hello-world-project/Makefile:
--------------------------------------------------------------------------------
1 |
2 | .PHONY: all
3 |
4 | all: hello-world.c
5 | gcc -Wall hello-world.c
6 |
--------------------------------------------------------------------------------
/test/hello-world-project/hello-world.c:
--------------------------------------------------------------------------------
1 | #include
2 |
3 | int
4 | main(void)
5 | {
6 | printf("hello world!\n")
7 | }
8 |
--------------------------------------------------------------------------------
/test/id_ppcompile_test:
--------------------------------------------------------------------------------
1 | -----BEGIN OPENSSH PRIVATE KEY-----
2 | b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAACFwAAAAdzc2gtcn
3 | NhAAAAAwEAAQAAAgEAtuXrT7Pa8HWOsLhTp6eGZ5RBmqd4RZHcdeVUXuFP6UGMtilqV3xV
4 | 1HdGmPRWxfwwpmrTAqyN62i1Cb8sS/9BIOsaVzJMaFy5RT+O3wGo31Pgasut0+v+r+nZmd
5 | ZfyrR8bSWNWv+Lq+Myh3kwcoYbQbR4X2ifdlsWSxayjvan//2w6r7fTw1Lx0hq759oCBYE
6 | oIhh2nIUg5aL8h2nPU1vvsvTodAVsKYQaY4Vj+4jx5Yu5kndl4TWBmc3g0xlArtI/FuRJg
7 | akE/mnhWH3SCdz0QaFLAXnWM20xFpquTtsftrYNBWLs1bIajNmckQ/WMgp0nsRXSreQTmV
8 | UYLuBOO3P6An3x7CMp1oWLenpYgEwxnLNxY3fr0Cj1gy7eBNiigEHQpFvTT4NJAxHE+ocT
9 | e2lBj1TPHHuFjaQuMMs6qGZOSduec6zPg56iJ2NSA/PaZxaTQVRoVgpnecJ7bPkD4Q7fT5
10 | RGUOKgke/uhWuBCWJ6nLpWT11mvcoQwgZXHkZbEAqVqmvk+UM4IyrmB9xu77g+kvt/IGwN
11 | 49py3pZktU72FF9RX37Zp1shwrUBoe5akdUDCuzo5ASzkO1kVfeDnUSAVg6I5s7tSeOpGm
12 | BaULynJBuMjQr2f1kXuu+6tXbyO7uPhFRCbwqT3SzHlcU/j1OXJ6cYIhAQTyHY75LVr50t
13 | 0AAAdQsf4hXLH+IVwAAAAHc3NoLXJzYQAAAgEAtuXrT7Pa8HWOsLhTp6eGZ5RBmqd4RZHc
14 | deVUXuFP6UGMtilqV3xV1HdGmPRWxfwwpmrTAqyN62i1Cb8sS/9BIOsaVzJMaFy5RT+O3w
15 | Go31Pgasut0+v+r+nZmdZfyrR8bSWNWv+Lq+Myh3kwcoYbQbR4X2ifdlsWSxayjvan//2w
16 | 6r7fTw1Lx0hq759oCBYEoIhh2nIUg5aL8h2nPU1vvsvTodAVsKYQaY4Vj+4jx5Yu5kndl4
17 | TWBmc3g0xlArtI/FuRJgakE/mnhWH3SCdz0QaFLAXnWM20xFpquTtsftrYNBWLs1bIajNm
18 | ckQ/WMgp0nsRXSreQTmVUYLuBOO3P6An3x7CMp1oWLenpYgEwxnLNxY3fr0Cj1gy7eBNii
19 | gEHQpFvTT4NJAxHE+ocTe2lBj1TPHHuFjaQuMMs6qGZOSduec6zPg56iJ2NSA/PaZxaTQV
20 | RoVgpnecJ7bPkD4Q7fT5RGUOKgke/uhWuBCWJ6nLpWT11mvcoQwgZXHkZbEAqVqmvk+UM4
21 | IyrmB9xu77g+kvt/IGwN49py3pZktU72FF9RX37Zp1shwrUBoe5akdUDCuzo5ASzkO1kVf
22 | eDnUSAVg6I5s7tSeOpGmBaULynJBuMjQr2f1kXuu+6tXbyO7uPhFRCbwqT3SzHlcU/j1OX
23 | J6cYIhAQTyHY75LVr50t0AAAADAQABAAACAC1hbPpwsOE6+fWlNrSBn5qxsXlzFieE4oOq
24 | LD4Cf7ZrmkNUkVs1sYIvOigXcDRdt6CDHuop8Gi5qTnK4m3U3s8RJo7+HvFCGIIzG/r/SW
25 | xoPmWhNfdANghl6KUACPKdx8W5LJKol3pFvDLbAgdYeQjbg4aAyhguz6A/+Hv6fYLJ6ozE
26 | YVoW/Xdr44SjM8fV1r4SON1fsvFXeE/Rxb4zKYfYwSEEJW2YNrhKFdWJi/0oqWhgaYf/4K
27 | 7kC2UbnnCIEbrz6VbbDPkb19IDlbykdVsm2AItUNK676BMovBk6y2qlTyPIAOWg9G+ASxW
28 | /LTFrYLZIFzSlyTt6bu41eAGtF+8d8DzXFi/nICdgfoNRlx5utx4FIxFxanYvhelWbdOLf
29 | YEdOKXXTG4HVcMpmOi7X9t6cnPKpw9rquOkXudE/q7p7fpZr4Avl8oertIrBsm8/+AWWg8
30 | F6XkRZpMHNsoTKcalD6h6cc5WnH2Gsn1g4Mjcju11eJmRDzWhRjAR6L57DSp7aA9Yo0A9X
31 | aINEv5ZGofxXfk9vEpKPFdO8fU+7C8YbkEeq2qUgxqUaVU0oh5j+4m7DbhABUH2djeRWaA
32 | rNY85m/38lobBwCYGolHsiEMp93ift4oAEJ0BiifGJ0J228Zbe9OK+fktTyRK+meN5ucq/
33 | 6o3cE8z1gRtTxiAu1NAAABAQCHuG/94bl0Ir+2Uu/phVAVMdJxKjitc9n92fysy1j0fAte
34 | 1qZJgEhPCSampoFqVMOjDWOEo0So8tWt2rUWh0xdT9M/oDofYEkrA94whDJ9A8n0vlNB27
35 | 0CYSQl6lM/b1A13mO1c8wpEEucAWEiFNWUHx52FOF6xYZmr1R6LsbpXNsGwhvBkpdXQ6oB
36 | lH6zrFA6VmPsTl2zwja42po1AWz2xeXMbQleKnkWyKloFqxOH2nn50/J4pH5RYqHmy1sId
37 | fOh/QpUdB8d7FgGAGxp1xv+VEQAjD13ROiFnzA7YAkbA/d1/iygV11vkHugfV4LlrLyVb5
38 | zCr04fOn7YrgUDObAAABAQDnlIbPP4MVxmQAo+efrnSgGp62eF6p7UxcwWuxe+4VyoUzhQ
39 | 1vZQk10W6Ho+81Wxakf0rgIv5TjB+OPBZOK/EvbWcaOs79csvwODHVfWVONSNfKORXaovm
40 | wPwwUApIAM0PstkO1zAlX3uDP+3kUnKt/QsO31k6gjuVHFyD7JGPuGnRjbnmO4aqQIGmKQ
41 | mz4EKl0VpmbnPSxBLRUemgsufau8MLioliA75iRTZKknG16gOYTGsA2s1kHgLGFOeQAzIS
42 | /HBrpCNZHJ/sggIHe0ldck0Lo32RuIqyMuRlkgJjc5bqHJQB75geoWWGWytg1a3sfjiHwB
43 | OxStGAK3OxKOqHAAABAQDKLzo5OqyyWw+Oj6CC1ZQTFg6TJdgTbi9oMsQLoIceX+Cg+bky
44 | sb3Gi1UFeNx69r5npICI4DKwCqCgqjrczvRd6srnWAGDoKCdfJB0cGSBXro7PWOGjNROJP
45 | sak39Ek8hOFnZSspLhQAkj7pCcbWJ5Zn2en4OZDyhyuAnKHV9Cbzwd/gPYNpXFkPv597nB
46 | rFH+yC4+9av9imKQLg3GdWrpQhXbdFT7KVEwDO3VJ8VDFzfE8pFwuo0utddCC8jpnljH5B
47 | Xsfy3K7dAffqRBXaxo8XL5omBwU4ApnmahRFQbCKg8lcbcPF7WGGXLJqV7n97U+ZqeltyR
48 | LznHd2dmurx7AAAAGWhnd0Bsb2NhbGhvc3QubG9jYWxkb21haW4B
49 | -----END OPENSSH PRIVATE KEY-----
50 |
--------------------------------------------------------------------------------
/test/id_ppcompile_test.pub:
--------------------------------------------------------------------------------
1 | ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQC25etPs9rwdY6wuFOnp4ZnlEGap3hFkdx15VRe4U/pQYy2KWpXfFXUd0aY9FbF/DCmatMCrI3raLUJvyxL/0Eg6xpXMkxoXLlFP47fAajfU+Bqy63T6/6v6dmZ1l/KtHxtJY1a/4ur4zKHeTByhhtBtHhfaJ92WxZLFrKO9qf//bDqvt9PDUvHSGrvn2gIFgSgiGHachSDlovyHac9TW++y9Oh0BWwphBpjhWP7iPHli7mSd2XhNYGZzeDTGUCu0j8W5EmBqQT+aeFYfdIJ3PRBoUsBedYzbTEWmq5O2x+2tg0FYuzVshqM2ZyRD9YyCnSexFdKt5BOZVRgu4E47c/oCffHsIynWhYt6eliATDGcs3Fjd+vQKPWDLt4E2KKAQdCkW9NPg0kDEcT6hxN7aUGPVM8ce4WNpC4wyzqoZk5J255zrM+DnqInY1ID89pnFpNBVGhWCmd5wnts+QPhDt9PlEZQ4qCR7+6Fa4EJYnqculZPXWa9yhDCBlceRlsQCpWqa+T5QzgjKuYH3G7vuD6S+38gbA3j2nLelmS1TvYUX1FfftmnWyHCtQGh7lqR1QMK7OjkBLOQ7WRV94OdRIBWDojmzu1J46kaYFpQvKckG4yNCvZ/WRe677q1dvI7u4+EVEJvCpPdLMeVxT+PU5cnpxgiEBBPIdjvktWvnS3Q== hgw@localhost.localdomain
2 |
--------------------------------------------------------------------------------
/test/ppcompile-test.el:
--------------------------------------------------------------------------------
1 | ;;; ppcompile-test.el --- Tests for ppcompile
2 |
3 | ;; Copyright (C) 2015 Free Software Foundation, Inc.
4 |
5 | ;; Author: Guangwang Huang
6 |
7 | ;; This file is part of GNU Emacs.
8 |
9 | ;; GNU Emacs is free software: you can redistribute it and/or modify
10 | ;; it under the terms of the GNU General Public License as published by
11 | ;; the Free Software Foundation, either version 3 of the License, or
12 | ;; (at your option) any later version.
13 |
14 | ;; GNU Emacs is distributed in the hope that it will be useful,
15 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 | ;; GNU General Public License for more details.
18 |
19 | ;; You should have received a copy of the GNU General Public License
20 | ;; along with GNU Emacs. If not, see .
21 |
22 | ;;; Commentary:
23 | ;;
24 |
25 | ;;; Code:
26 |
27 | (require 'ert)
28 | (require 'ppcompile)
29 |
30 | (ert-deftest test-authsource ()
31 | (let ((auth-sources '("./test/authinfo.txt"))
32 | (ppcompile-ssh-host "example.com")
33 | (ppcompile-ssh-port 1234)
34 | (ppcompile-ssh-user "foobar"))
35 | (should
36 | (string= "foo:BAR123!" (ppcompile-get-ssh-password)))))
37 |
38 | (ert-deftest test-replace-path ()
39 | (let ((content (concat "/home/foo/Lorem ipsum dolor"
40 | "/home/foo sit amet, consectetur adipiscing elit."
41 | " /home/bar/Pellentesque sem mauris")))
42 | (with-temp-buffer
43 | (insert content)
44 | (let ((ppcompile--current-buffer (current-buffer)))
45 | (setq ppcompile-path-mapping-alist '(("/home/foo" . "/home/barr")
46 | ("/home/bar/" . "/home/baz")))
47 | (ppcompile--replace-path (current-buffer) "finish-msg"))
48 | (should
49 | (string= (concat "/home/barr/Lorem ipsum dolor"
50 | "/home/foo sit amet, consectetur adipiscing elit."
51 | " /home/baz/Pellentesque sem mauris")
52 | (buffer-string)))
53 |
54 | (erase-buffer)
55 | (insert content)
56 | (let ((ppcompile--current-buffer (current-buffer)))
57 | ;; replaced in 2 rounds
58 | (setq ppcompile-path-mapping-alist '(("/home/foo" . "/home/bar")
59 | ("/home/bar/" . "/home/baz")))
60 | (ppcompile--replace-path (current-buffer) "finish-msg"))
61 | (should
62 | (string= (concat "/home/baz/Lorem ipsum dolor"
63 | "/home/foo sit amet, consectetur adipiscing elit."
64 | " /home/baz/Pellentesque sem mauris")
65 | (buffer-string))))))
66 |
67 | (ert-deftest test-expect-available-p ()
68 | (let ((ppcompile-expect-executable "/tmp/fake-expect"))
69 | (should-not (ppcompile--expect-available-p))
70 |
71 | (shell-command "touch /tmp/fake-expect")
72 | (should-not (ppcompile--expect-available-p))
73 |
74 | (shell-command "chmod +x /tmp/fake-expect")
75 | (should (ppcompile--expect-available-p))
76 |
77 | (setq ppcompile-with-password-script-path "/tmp/with-password.exp")
78 | (should-not (ppcompile--expect-available-p))
79 |
80 | (shell-command "rm /tmp/fake-expect")))
81 |
82 | (ert-deftest test-with-sshd ()
83 | "Test the ping-pong compile function with a ad-hoc sshd server,
84 | which listens at localhost:22000 by running `/usr/sbin/sshd -p 22000'.
85 |
86 | This test should be run manually due to the extra work of starting up sshd.
87 |
88 | The public key file should be copied to that sshd server for the first run:
89 | ssh-copy-id -p 22000 -i ./test/id_ppcompile_test localhost
90 |
91 | The key pair is generated by:
92 | ssh-keygen -t rsa -b 4096 -f ./test/id_ppcompile_test
93 | "
94 | :tags '(sshd)
95 | (test--ppcompile-the-project)
96 | (next-error)
97 | (switch-to-buffer "hello-world.c") ; the source file should be targeted now!
98 | (should
99 | (= 6 (line-number-at-pos)))
100 | (kill-buffer "hello-world.c")
101 |
102 | ;; test it without expect
103 | (let ((ppcompile-expect-executable "/tmp/expect-nowhere"))
104 | (test--ppcompile-the-project)
105 | (next-error)
106 | (switch-to-buffer "hello-world.c") ; the source file should be targeted now!
107 | (should
108 | (= 6 (line-number-at-pos)))
109 | (kill-buffer "hello-world.c")))
110 |
111 | (defun test--ppcompile-the-project ()
112 | "Run `ppcompile' with the hello-world project."
113 | (delete-directory "/tmp/hello-world-project/" 'recursive)
114 | (set-file-modes "./test/id_ppcompile_test" #o600) ; As `ssh' requested
115 | (let ((enable-local-variables :all)
116 | (project-find-functions #'(lambda (dir) (cons 'test dir)))
117 | (compilation-read-command nil)
118 | (ppcompile--debug nil))
119 | (find-file "./test/hello-world-project/hello-world.c")
120 | (ppcompile) ; run it in the hello-world.c buffer
121 | (sleep-for 1) ; wait for finishing compiling, kinda silly
122 | (kill-buffer "hello-world.c")))
--------------------------------------------------------------------------------
/with-password.exp:
--------------------------------------------------------------------------------
1 | #!/usr/bin/expect
2 |
3 | # manpage expect(1) is helpful.
4 |
5 | # exp_internal 1 # debug
6 |
7 | # Timeout for, e.g., slow connections
8 | set timeout 10
9 |
10 | # Though it seems this doesn't work.
11 | unset -nocomplain ::env(SSH_ASKPASS)
12 |
13 | set cmd [lrange $argv 0 end]
14 | # expand the list
15 | spawn {*}$cmd
16 |
17 | expect {
18 | "assword: " {
19 | set passwd $::env(PPCOMPILE_PASSWORD)
20 | if {"" eq $passwd} {
21 | puts "Empty ppcompile password!"
22 | exit 1
23 | }
24 | send "${passwd}\r"
25 |
26 | expect {
27 | # If the password prompt pops up once again
28 | "assword: " {
29 | puts "Incorrect password!"
30 | exit 1
31 | }
32 | }
33 | }
34 |
35 | "yes/no" {
36 | send "yes\r"
37 | exp_continue
38 | }
39 |
40 | timeout {
41 | puts "timeout"
42 | exit 1
43 | }
44 |
45 | # Password is not needed for, e.g., public key authentication
46 | eof {
47 | puts "The end."
48 | }
49 |
50 | # fallback
51 | -regex ".*\n" {
52 | exp_continue
53 | }
54 | }
55 |
56 | # interact
57 |
58 | # catch and propagate the exit code
59 | catch wait result
60 | exit [lindex $result 3]
61 |
--------------------------------------------------------------------------------