├── .gitignore ├── LICENSE ├── README.org └── code-archive.el /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | *# 3 | *~ 4 | gmon.out 5 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | 2 | Archive and reference source code snippets 3 | 4 | This package provides commands for saving selecting code regions and inserting them as org-mode styled code blocks. 5 | These code blocks are tagged with an id that allows jumping back to the original source file. 6 | The original source file is archived in a git managed repo each time a code block is saved. 7 | 8 | Saving full file copies enables referencing the orignal context and avoids the problem of locating bookmarked regions 9 | when the file becomes massively mutated or deleted. Using git solves 10 | the problem of saving multiple versions of a file history in a space efficient way. 11 | 12 | Additional helpers are provided for org-capture templates. 13 | 14 | * Installation and Setup 15 | =code-archive= is available from the MELPA package archive. 16 | See https://melpa.org/#/getting-started for help getting it setup. 17 | 18 | in your config file: 19 | 20 | Set the code archive directory, which defaults to =~/code-archive= 21 | #+BEGIN_SRC emacs-lisp 22 | (setq code-archive-dir "~/code-archive-directory") 23 | #+END_SRC 24 | The variable =code-archive-src-map= maps major modes to the mode that is used for the org block source type. For example: 25 | #+BEGIN_SRC emacs-lisp 26 | (push '(lisp-interaction-mode . "emacs-lisp") code-archive-src-map) 27 | #+END_SRC 28 | Set code-archive-src-map to nil to disable it. 29 | 30 | These variables can also be edited using custom by selecting the group "code-archive" 31 | 32 | * Usage 33 | ** Save and insert org code block 34 | 1. Select code. With a region selected in a source file run =M-x code-archive-save-code=, 35 | This will save that region to an internal stack. Multiple regions can be saved consecutively in this way. 36 | The source file will be added or updated in the git archive. 37 | 38 | 2. Insert the code block. =M-x code-archive-insert-org-block= will insert the most recently saved codeblock. 39 | This should be called for each corresponding call to =code-archive-save-code=, 40 | ** Jumping to source files 41 | With the point at the start of a codeblock run =M-x code-archive-goto-src= to jump to the source file. 42 | 43 | This will open the original source file if it has not changed. If it has been changed or deleted since the file 44 | was archived, the archived version will be opened instead. 45 | 46 | Archived files are opened with =code-archive-mode= which recognizes the following keys: 47 | | o | Open the original source file at the same position if it exists | 48 | | q | Kill the buffer. | 49 | 50 | ** org-capture templates 51 | The functions ~code-archive-do-org-capture~ and ~code-archive-org-src-tag~ are provided 52 | for use in org-capture templates. They allow the capture template to archive the 53 | file and save the region as a codeblock in some designated file. 54 | Both require the file name to be passed to it with the =%F= escape. 55 | 56 | ~code-archive-do-org-capture~ will create a codeblock out of the selected region, saving the 57 | file to the git archive in the usual way. This is equivalent to calling manually calling =code-archive-save-code= in the source buffer and calling =code-archive-insert-org-block= in the capture buffer. 58 | 59 | ~code-archive-org-src-tag~ will insert an org tag of the source type. 60 | 61 | An example org capture template using both these functions: 62 | #+BEGIN_SRC emacs-lisp 63 | (setq org-capture-templates 64 | (quote (("c" "Code" entry (file "~/path/to/code.org") 65 | "* %? %(code-archive-org-src-tag \"%F\") 66 | :PROPERTIES: 67 | :FILE: %F 68 | :END: 69 | %(code-archive-do-org-capture \"%F\")") 70 | ))) 71 | #+END_SRC 72 | * Todo 73 | - modify html export to make the code blocks clickable, have it open the original or archived source file. 74 | - possibly enable multiple code archives. Currently not possible 75 | because the code block ID is global. 76 | - Use the derived-mode-parent property to find the mode to use 77 | as the source block type. This will eliminate the need for code-archive-src-map 78 | -------------------------------------------------------------------------------- /code-archive.el: -------------------------------------------------------------------------------- 1 | ;;; code-archive.el --- git supported code archive and reference for org-mode -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 Michael Schuldt 4 | 5 | ;; Author: Michael Schuldt 6 | ;; Version: 0.3 7 | ;; Package-Requires: ((emacs "24.3")) 8 | ;; URL: https://github.com/mschuldt/code-archive 9 | 10 | ;; This program is free software; you can redistribute it and/or 11 | ;; modify it under the terms of the GNU General Public License as 12 | ;; published by the Free Software Foundation; either version 2, or (at 13 | ;; your option) any later version. 14 | 15 | ;; This program is distributed in the hope that it will be useful, but 16 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 | ;; General Public License for more details. 19 | 20 | ;; You should have received a copy of the GNU General Public License 21 | ;; along with GNU Emacs. If not, see . 22 | 23 | ;;; Commentary: 24 | ;; 25 | ;; Archive and reference source code snippets 26 | ;; 27 | ;; This package provides commands for saving selecting code regions and 28 | ;; inserting them as org-mode styled code blocks. These code blocks are 29 | ;; tagged with an id that allows jumping back to the original source file. 30 | ;; The original source file is archived in a git managed repo each time 31 | ;; a code block is saved. 32 | ;; 33 | ;; Saving full file copies enables referencing the orignal context and 34 | ;; avoids the problem of locating bookmarked regions when the file becomes 35 | ;; massively mutated or deleted. Using git solves the problem of saving 36 | ;; multiple versions of a file history in a space efficient way. 37 | ;; 38 | ;; Additional helpers are provided for org-capture templates. 39 | ;; 40 | ;; See the README for usage at https://github.com/mschuldt/code-archive 41 | ;; 42 | ;;; Code: 43 | 44 | (require 'cl) 45 | 46 | (defgroup code-archive nil 47 | "Source code archival and reference" 48 | :prefix "code-archive-" 49 | :group 'applications) 50 | 51 | (defcustom code-archive-dir "~/code-archive" 52 | "Directory in which to archive source files." 53 | :group 'code-archive 54 | :type 'string) 55 | 56 | (defcustom code-archive-src-map '((lisp-interaction-mode . "emacs-lisp") 57 | (makefile-automake-mode . "makefile") 58 | (GNUmakefile . "makefile") 59 | (makefile-gmake-mode . "makefile") 60 | (fundamental-mode . "text") 61 | (mhtml-mode . "html") 62 | ) 63 | "Alist mapping major mode name to source name. 64 | The source name is the alternative mode to use without the -mode suffix" 65 | :group 'code-archive 66 | :type '(alist :key-type (symbol :tag "Major mode name") 67 | :value-type (string :tag "source name for org block"))) 68 | 69 | (defcustom code-archive-git-executable "git" 70 | "The Git executable used by code-archive." 71 | :group 'code-archive 72 | :type 'string) 73 | 74 | (defvar code-archive--save-stack nil) 75 | 76 | (defvar code-archive--codeblocks (make-hash-table)) 77 | 78 | (defvar code-archive--initialized nil 79 | "Non-nil when the code archive has been initialized.") 80 | 81 | (defvar code-archive--codeblocks-loaded nil 82 | "Non-nil when codeblocks are loaded.") 83 | 84 | (defvar code-archive--last-id nil 85 | "Value of the last codeblock ID.") 86 | 87 | (defstruct code-archive--entry 88 | codeblock src-type string) 89 | 90 | (defstruct code-archive--codeblock 91 | id file archived-file line archived-git-commit archived-md5) 92 | 93 | (defun code-archive--link-file () 94 | "Return the archive link-file." 95 | (concat (file-name-as-directory code-archive-dir) "_code-links.el")) 96 | 97 | (defun code-archive--run-git (&rest command-args) 98 | "Execute Git with COMMAND-ARGS, display any output." 99 | (let (s) 100 | (with-temp-buffer 101 | (cd code-archive-dir) 102 | (dolist (args command-args) 103 | (erase-buffer) 104 | (apply 'call-process code-archive-git-executable nil t nil args) 105 | (setq s (buffer-string)) 106 | (message (format "command-args: %s" command-args)) 107 | (when (and (not (equal (caar command-args) "show")) 108 | (> (length s) 0)) 109 | (message "%s" s)) 110 | )) 111 | s)) 112 | 113 | (defun code-archive-init () 114 | "Initialize the code archive." 115 | (unless (or code-archive--initialized 116 | (file-exists-p (concat (file-name-as-directory code-archive-dir) 117 | ".git"))) 118 | (unless (file-exists-p code-archive-dir) 119 | (mkdir code-archive-dir)) 120 | (with-temp-buffer 121 | (write-file (code-archive--link-file))) 122 | (code-archive--run-git '("init") 123 | '("add" "*") 124 | '("commit" "-m" "initial"))) 125 | (setq code-archive--initialized t)) 126 | 127 | (defun code-archive--source-type () 128 | "Return the source type of the current buffer." 129 | (when major-mode 130 | (or (cdr (assoc major-mode code-archive-src-map)) 131 | (car (split-string (symbol-name major-mode) "-mode"))))) 132 | 133 | ;;;###autoload 134 | (defun code-archive-save-code () 135 | "Archive the current buffer and save the region to the code archive stack." 136 | (interactive) 137 | (code-archive-init) 138 | (let* ((file (buffer-file-name)) 139 | (line (and file 140 | (line-number-at-pos (and (region-active-p) 141 | (region-beginning)) 142 | t))) 143 | (region-string (if (region-active-p) 144 | (buffer-substring (region-beginning) 145 | (region-end)) 146 | "")) 147 | (codeblock (code-archive--save-buffer-file))) 148 | (setf (code-archive--codeblock-file codeblock) file) 149 | (setf (code-archive--codeblock-line codeblock) line) 150 | (push (make-code-archive--entry :codeblock codeblock 151 | :src-type (code-archive--source-type) 152 | :string region-string) 153 | code-archive--save-stack))) 154 | 155 | (defun code-archive--format-org-block () 156 | "Format an `org-mode' styled code block sourced from the code archive stack. 157 | This consumes an entry from ‘code-archive--save-stack’." 158 | (code-archive--load-codeblocks) 159 | (let* ((entry (pop code-archive--save-stack)) 160 | (codeblock (code-archive--entry-codeblock entry)) 161 | (src-type (code-archive--entry-src-type entry)) 162 | (lines (split-string (code-archive--entry-string entry) "\n")) 163 | (code (mapconcat (lambda (line) (concat " " line)) lines "\n")) 164 | (id (code-archive--next-id))) 165 | (setf (code-archive--codeblock-id codeblock) id) 166 | (code-archive--add-codeblock codeblock) 167 | (format "\n#+BEGIN_SRC %s :var _id=%s 168 | %s\n#+END_SRC 169 | " src-type id code))) 170 | 171 | ;;;###autoload 172 | (defun code-archive-insert-org-block () 173 | "Insert an `org-mode' styled code block sourced from the code archive stack. 174 | This consumes an entry from ‘code-archive--save-stack’." 175 | (interactive) 176 | (if code-archive--save-stack 177 | (save-excursion 178 | (insert (code-archive--format-org-block))) 179 | (message "code archive stack is empty"))) 180 | 181 | ;;;###autoload 182 | (defun code-archive-do-org-capture (filename) 183 | "For use in an org capture template, insert an org code block. 184 | FILENAME is the name of the file visited by buffer when org capture was called. 185 | Usage in capture template: (code-archive-do-org-capture \"%F\")" 186 | (when (string= filename "") 187 | (error "Buffer buffer-file-name was probably unset")) 188 | (with-current-buffer (find-buffer-visiting filename) 189 | (code-archive-save-code)) 190 | (code-archive--format-org-block)) 191 | 192 | ;;;###autoload 193 | (defun code-archive-org-src-tag (filename) 194 | "For use in an org capture template, insert an org code block. 195 | FILENAME is the name of the file visited by buffer when org capture was called. 196 | Usage in capture template: (code-archive-org-src-tag \"%F\")" 197 | (when (string= filename "") 198 | (error "Buffer buffer-file-name was probably unset")) 199 | (let (src-type) 200 | (with-current-buffer (find-buffer-visiting filename) 201 | (setq src-type (code-archive--source-type))) 202 | (if src-type 203 | (progn (dolist (x '(("-" . "_") 204 | ("+" . "p") 205 | )) 206 | (setq src-type (replace-regexp-in-string (car x) (cdr x) src-type))) 207 | (format ":%s:" src-type)) 208 | ""))) 209 | 210 | (defun code-archive--set-auto-mode (filename) 211 | "Set auto mode for current buffer displaying FILENAME." 212 | (let ((buffer-file-name filename)) 213 | (set-auto-mode))) 214 | 215 | (defun code-archive--get-codeblock-id () 216 | "Return the id of the codeblock at point." 217 | (save-excursion 218 | (end-of-line) 219 | (let ((bound (point))) 220 | (beginning-of-line) 221 | (if (looking-at "[ \t]*#\\+BEGIN_SRC") 222 | (if (re-search-forward "_id=\\([0-9]+\\)" bound) 223 | (string-to-number (match-string 1)) 224 | (message "Error: could not find block id") 225 | nil) 226 | (message "Error: not on a source block header") 227 | nil)))) 228 | 229 | ;;;###autoload 230 | (defun code-archive-goto-src () 231 | "Open the original source file of the codeblock at point. 232 | The point must be on the first line." ;;TODO: jump from anywhere in the source block 233 | (interactive) 234 | (let ((id (code-archive--get-codeblock-id)) 235 | info) 236 | (when id 237 | (setq info (code-archive--get-block-info id)) 238 | (if info 239 | (let* ((source-file (code-archive--codeblock-file info)) 240 | (file source-file) 241 | (archive-md5 (code-archive--codeblock-archived-md5 info)) 242 | (line (1- (code-archive--codeblock-line info))) 243 | (file-exists (file-exists-p file)) 244 | hash archive-file filename buffer-name) 245 | (if (and file-exists 246 | (string= (code-archive--file-md5 file) 247 | archive-md5)) 248 | (progn (find-file-other-window file) 249 | (goto-char 1) 250 | (forward-line line) 251 | (message "Visiting original version")) 252 | ;; else: 253 | (setq filename (format "%s.%s" 254 | (file-name-base file) 255 | (file-name-extension file)) 256 | hash (code-archive--codeblock-archived-git-commit info) 257 | buffer-name (concat filename "-" hash)) 258 | (when (get-buffer buffer-name) 259 | (kill-buffer buffer-name)) 260 | (setq buf (get-buffer-create buffer-name) 261 | archive-file (code-archive--codeblock-archived-file info)) 262 | (with-current-buffer buf 263 | (insert (code-archive--run-git 264 | (list "show" (concat hash ":" archive-file)))) 265 | (code-archive--set-auto-mode filename) 266 | (code-archive-mode) 267 | (setq code-archive--source-file source-file) 268 | (setq code-archive--source-line line) 269 | (goto-char 1) 270 | (forward-line line) 271 | (pop-to-buffer (current-buffer))) 272 | (message (concat "Visiting archived version. " 273 | (if file-exists 274 | "Press 'o' to visit original changed file" 275 | "Original file deleted."))))) 276 | (message "Error: no link info for codeblock id: %s" id))))) 277 | 278 | (defun code-archive--next-id () 279 | "Return the next source block id." 280 | (assert (not (null code-archive--last-id))) 281 | (setq code-archive--last-id (1+ code-archive--last-id))) 282 | 283 | (defun code-archive--file-md5 (filename) 284 | "Calculate the md5 digest of the file FILENAME." 285 | (with-temp-buffer 286 | (insert-file-contents-literally filename) 287 | (md5 (buffer-string)))) 288 | 289 | (defun code-archive--save-buffer-file () 290 | "Archive the current buffer in `code-archive-dir'. 291 | Return the archive data in a code-archive--codeblock struct." 292 | (save-buffer) 293 | (let* ((str (buffer-string)) 294 | (checksum (md5 str)) 295 | (path (or (buffer-file-name) "")) 296 | (name (replace-regexp-in-string "[/*]" "_" 297 | (or (file-name-nondirectory path) 298 | (buffer-name)))) 299 | (filename (format "%s_%s" (md5 (or path (buffer-name))) name)) 300 | (archive-path (concat (file-name-as-directory code-archive-dir) 301 | filename)) 302 | commit curr-md5 commit-hash) 303 | 304 | (if (file-exists-p archive-path) 305 | ;; check if file has changed 306 | (progn (setq curr-md5 (code-archive--file-md5 archive-path)) 307 | (unless (string= checksum curr-md5) 308 | (copy-file path archive-path :overwrite) 309 | (setq commit "changed"))) 310 | (progn (if path 311 | ;; copy file to archive directory 312 | (copy-file path archive-path) 313 | (with-temp-buffer 314 | ;; file does not exist on disk, save the buffer contents to file 315 | (insert str) 316 | (write-file archive-path))) 317 | (setq commit "added"))) 318 | 319 | (when commit 320 | (code-archive--run-git (list "add" filename) 321 | (list "commit" "-m" (format "%s: %s" 322 | commit path)))) 323 | 324 | (setq commit-hash (code-archive--strip-end 325 | (code-archive--run-git '("rev-parse" "HEAD")) 326 | "\n")) 327 | (make-code-archive--codeblock :file path 328 | :archived-file filename 329 | :archived-git-commit commit-hash 330 | :archived-md5 checksum) 331 | )) 332 | 333 | (defun code-archive--char-split-string (string) 334 | "Split a STRING into its charaters." 335 | (cdr (butlast (split-string string "")))) 336 | 337 | (defun code-archive--strip-end (string &optional char) 338 | "If CHAR occurs at the end of STRING, remove it." 339 | (let ((split (nreverse (code-archive--char-split-string string))) 340 | (char (or char " "))) 341 | (while (string= char (car split)) 342 | (setq split (cdr split))) 343 | (mapconcat 'identity (nreverse split) ""))) 344 | 345 | (defun code-archive--record-to-vector (record) 346 | "Convert RECORD type to a vector." 347 | (let* ((len (1- (length record))) 348 | (v (make-vector len nil))) 349 | (dotimes (i len) 350 | (aset v i (aref record (1+ i)))) 351 | v)) 352 | 353 | (defun code-archive--codeblock-to-vector (codeblock) 354 | "Convert CODEBLOCK type to a vector." 355 | (cond ((vectorp codeblock) 356 | codeblock) 357 | ((recordp codeblock) 358 | (code-archive--record-to-vector codeblock)) 359 | (t (error "Unhanded type: %s" (type-of codeblock))))) 360 | 361 | (defun code-archive--array-to-codeblock (a) 362 | "Create a codeblock struct from the array A." 363 | (make-code-archive--codeblock :id (aref a 0) 364 | :file (aref a 1) 365 | :archived-file (aref a 2) 366 | :line (aref a 3) 367 | :archived-git-commit (aref a 4) 368 | :archived-md5 (aref a 5))) 369 | 370 | (defun code-archive--add-codeblock (codeblock) 371 | "Add a new CODEBLOCK link to the archive." 372 | (code-archive--load-codeblocks) 373 | (with-temp-buffer 374 | (let ((print-level nil) 375 | (print-length nil)) 376 | (print (code-archive--codeblock-to-vector codeblock) (current-buffer))) 377 | (append-to-file (point-min) 378 | (point-max) 379 | (code-archive--link-file))) 380 | (puthash (code-archive--codeblock-id codeblock) 381 | codeblock 382 | code-archive--codeblocks) 383 | (code-archive--run-git '("add" "*") 384 | (list "commit" "-m" 385 | (format "code block link %s" 386 | (code-archive--codeblock-id codeblock))))) 387 | 388 | (defun code-archive--get-block-info (id) 389 | "Return the source information for codeblock with given ID." 390 | (code-archive--load-codeblocks) 391 | (gethash id code-archive--codeblocks)) 392 | 393 | (defun code-archive--load-codeblocks () 394 | "Load code archive codeblocks links." 395 | (unless code-archive--codeblocks-loaded 396 | (let ((c 0) 397 | (codeblocks (make-hash-table)) 398 | (block-id 0) 399 | (max-id 0) 400 | blocks) 401 | (with-temp-buffer 402 | (condition-case err 403 | (progn 404 | (insert-file-contents-literally (code-archive--link-file)) 405 | (goto-char (point-max)) 406 | (insert ")") 407 | (goto-char 1) 408 | (insert "(") 409 | (goto-char 1) 410 | (setq blocks (mapcar 'code-archive--array-to-codeblock 411 | (read (current-buffer))))) 412 | (error (message "Error reading kb codeblock file '%s': %s" 413 | (code-archive--link-file) err)))) 414 | (dolist (x blocks) 415 | (if (gethash (code-archive--codeblock-id x) codeblocks) 416 | (error "Duplicate codeblock link for id: %s" 417 | (code-archive--codeblock-id x)) 418 | (setq block-id (code-archive--codeblock-id x) 419 | max-id (max block-id max-id)) 420 | (puthash block-id x codeblocks) 421 | (setq c (1+ c)))) 422 | (setq code-archive--codeblocks codeblocks 423 | code-archive--last-id max-id) 424 | (message (format "loaded %s codeblock links" c))) 425 | (setq code-archive--codeblocks-loaded t))) 426 | 427 | ;;; minor mode for viewing archived code 428 | 429 | (defvar-local code-archive--source-file nil 430 | "The original source file path for the archived buffer file") 431 | 432 | (defvar-local code-archive--source-line nil 433 | "The line number in the original source file") 434 | 435 | (defun code-archive-open-original-file () 436 | "Open the original source file associated with the archived buffer source." 437 | (interactive) 438 | (if (file-exists-p code-archive--source-file) 439 | (let ((line code-archive--source-line)) 440 | (find-file-other-window code-archive--source-file) 441 | (goto-char 1) 442 | (forward-line line)) 443 | (message "Original file does not exist"))) 444 | 445 | (defun code-archive-kill-buffer () ;; prevent remapping by ido 446 | "Kill the current buffer." 447 | (interactive) 448 | (kill-buffer)) 449 | 450 | (defvar code-archive-mode-map 451 | (let ((map (make-sparse-keymap 'code-archive-mode-map))) 452 | (define-key map (kbd "o") 'code-archive-open-original-file) 453 | (define-key map (kbd "q") 'code-archive-kill-buffer) 454 | map) 455 | "The variable ‘code-archive-mode’ keymap.") 456 | 457 | (define-minor-mode code-archive-mode 458 | "Minor mode for viewing archived files" 459 | nil "-code-archive" code-archive-mode-map 460 | (read-only-mode 1)) 461 | 462 | (provide 'code-archive) 463 | 464 | ;;; code-archive.el ends here 465 | --------------------------------------------------------------------------------