diff options
| -rw-r--r-- | LICENSE | 674 | ||||
| -rw-r--r-- | README.md | 13 | ||||
| -rw-r--r-- | README.org | 10 | ||||
| -rw-r--r-- | seam-export.el | 299 | ||||
| -rw-r--r-- | seam-html.el | 363 | ||||
| -rw-r--r-- | seam-test.el | 402 | ||||
| -rw-r--r-- | seam.el | 568 |
7 files changed, 2329 insertions, 0 deletions
@@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a3f75e4 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +[Seam](https://wiki.plexwave.org/seam) is a personal wiki system based +on [Org mode](https://orgmode.org/). + +# Installation +Clone this repo and add it to your load path. As long as your system +has `find` and `grep` installed, no further setup should be required. + +# Documentation +For now, the best way to learn about Seam is the [project +page](https://wiki.plexwave.org/seam) and the +[tutorial](https://wiki.plexwave.org/seam-tutorial). I have +endeavored to make Seam fairly self-documenting, so also see the +docstrings and the Seam customization group. diff --git a/README.org b/README.org new file mode 100644 index 0000000..f5ea4ce --- /dev/null +++ b/README.org @@ -0,0 +1,10 @@ +[[https://wiki.plexwave.org/seam][Seam]] is a personal wiki system based on [[https://orgmode.org/][Org mode]]. + +* Installation +Clone this repo and add it to your load path. As long as your system +has =find= and =grep= installed, no further setup should be required. + +* Documentation +For now, the best way to learn about Seam is the [[https://wiki.plexwave.org/seam][project page]] and the +[[https://wiki.plexwave.org/seam-tutorial][tutorial]]. I have endeavored to make Seam fairly self-documenting, so +also see the docstrings and the Seam customization group. diff --git a/seam-export.el b/seam-export.el new file mode 100644 index 0000000..3293ef0 --- /dev/null +++ b/seam-export.el @@ -0,0 +1,299 @@ +;;; seam-export.el --- Seam HTML exporter -*- lexical-binding: t -*- + +;; Copyright (c) 2025 Spencer Williams + +;; Author: Spencer Williams <spnw@plexwave.org> + +;; SPDX-License-Identifier: GPL-3.0-or-later + +;; This file is not part of GNU Emacs. + +;; This program is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see <http://www.gnu.org/licenses/>. + +;;; Commentary: + +;; Frontend for Seam's HTML exporter. + +;;; Code: + +(require 'cl-lib) +(require 'seam-html) + +(defvar seam-export--types nil) +(defvar seam-export--template nil) +(defvar seam-export--root-path nil) +(defvar seam-export--no-extension nil) +(defvar seam-export--options nil) + +(defgroup seam-export nil + "Options for Seam exporter." + :tag "Seam Export" + :group 'seam) + +(defcustom seam-export-alist nil + "Association list used by Seam to determine how to export notes. + +The car of each element is an HTML directory to which Seam will export a +subset of notes. The cdr is a plist containing any number of these +properties: + + `:types' + + List of note types to export to this directory. Required. + + `:template-file' + + The HTML template file to be used by the exporter. If this is + missing, falls back to :template-string, `seam-export-template-file', + or `seam-export-template-string' in that order. + + `:template-string' + + The HTML template string to be used by the exporter. If this is + missing, falls back to :template-file, `seam-export-template-file', + or `seam-export-template-string' in that order. + + `:root-path' + + The root path used for rendering internal links. Defaults to \"\", + which means all paths are relative. + + `:no-extension' + + Whether to drop the \".html\" file extension in links. Defaults to + nil. + + `:backend-options' + + A plist of extra options passed to the Org HTML backend. This can be + used to override any of the defaults set in + `seam-export-backend-options'." + :group 'seam-export + :type '(alist :key-type string :value-type plist)) + +(defcustom seam-export-template-file nil + "The HTML template file to be used by the exporter. The template format +is documented at `seam-export-default-template-string'. + +See `seam-export-alist' for more information about specifying templates." + :group 'seam-export + :type '(choice file (const nil))) + +(defvar seam-export-default-template-string + "<!doctype html> +<html lang=\"en\"> +<head> +<meta charset=\"utf-8\" /> +<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" /> +<title>{{title}}</title> +</head> +<body> +<main> +<header> +<h1>{{title}}</h1> +<p class=\"modified\">Last modified: <time datetime=\"{{modified-dt}}\">{{modified}}</time></p> +</header> +{{contents}} +<section class=\"backlinks\"> +<h1>Backlinks</h1> +{{backlinks}} +</section> +</main> +</body> +</html>" + "The default HTML template string if no other template is specified. + +It should be plain HTML5. Several variables are defined which can be +interpolated using the {{variable}} syntax: + +- contents: The full HTML contents of the note, sans the title header. + +- title: The note's title (HTML-escaped). + +- backlinks: A list (<ul>) of notes that link to the given note. + +- modified: The human-readable date that the note was last modified. + See `seam-export-time-format'. + +- modified-dt: The machine-readable date that the note was last + modified. See `seam-export-time-format-datetime'.") + +(defcustom seam-export-template-string seam-export-default-template-string + "The HTML template string to be used by the exporter. The template +format is documented at `seam-export-default-template-string'. + +See `seam-export-alist' for more information about specifying templates." + :group 'seam-export + :type '(choice string (const nil))) + +(defcustom seam-export-time-format "%e %B %Y" + "Human-readable format for template time strings. Passed to +`format-time-string'." + :group 'seam-export + :type 'string) + +(defcustom seam-export-time-format-datetime "%Y-%m-%d" + "Machine-readable format for template time strings. Meant to be used in +the datetime attribute of <time>. Passed to `format-time-string'." + :group 'seam-export + :type 'string) + +(defcustom seam-export-time-zone t + "Time zone used for template time strings. Passed to +`format-time-string'." + :group 'seam-export + :type 'sexp) + +(defvar seam-export-backend-options + (list + :html-container "article" + :html-doctype "html5" + :html-html5-fancy t + :html-text-markup-alist + '((bold . "<strong>%s</strong>") + (code . "<code>%s</code>") + (italic . "<em>%s</em>") + (strike-through . "<s>%s</s>") + (underline . "<span class=\"underline\">%s</span>") + (verbatim . "<code>%s</code>")) + :html-toplevel-hlevel 1 + :html-use-infojs nil + :section-numbers nil + :time-stamp-file nil + :with-smart-quotes t + :with-toc nil)) + +(defmacro seam-export--to-string (&rest body) + (declare (indent 0)) + (let ((buf (gensym))) + `(let ((,buf (generate-new-buffer " *seam-export*"))) + (unwind-protect + (progn (with-temp-buffer + ,@body + ;; This let prevents Org from popping up a window. + (let ((org-export-show-temporary-export-buffer nil)) + (org-export-to-buffer 'seam ,buf nil nil nil t seam-export--options nil))) + (with-current-buffer ,buf + (buffer-string))) + (kill-buffer ,buf))))) + +;;; Some HACK-ery to get fully escaped and smartquote-ized string. +(defun seam-export--escape-string (s) + (string-remove-prefix + "<p>\n" + (string-remove-suffix + "</p>\n" + (seam-export--to-string + (insert s))))) + +(defun seam-export--replace-variable (var replacement) + (goto-char 1) + (while (re-search-forward (format "{{%s}}" var) nil t) + (replace-match replacement))) + +(defun seam-export--generate-backlinks (file) + (seam-export--to-string + (let ((files (sort + (let ((seam--subset seam-export--types)) + (cl-loop for x in (seam-get-links-to-file file) + collect (cons (seam-get-title-from-file x) x))) + :key #'car + :lessp #'string<))) + (when files + (cl-loop for (title . file) in files + do (insert (format "- [[seam:%s][%s]]\n" (file-name-base file) title))))))) + +(defun seam-export--note-to-html (note-file html-directory) + (seam-ensure-directory-exists html-directory) + (let ((html-file (file-name-concat html-directory + (concat (file-name-base note-file) ".html"))) + (modified (file-attribute-modification-time + (file-attributes note-file)))) + (with-temp-buffer + (insert seam-export--template) + (seam-export--replace-variable + "title" + (seam-export--escape-string + (seam-get-title-from-file note-file))) + (seam-export--replace-variable + "modified" + (format-time-string + seam-export-time-format + modified + seam-export-time-zone)) + (seam-export--replace-variable + "modified-dt" + (format-time-string + seam-export-time-format-datetime + modified + seam-export-time-zone)) + (seam-export--replace-variable + "contents" + (seam-export--to-string + (insert-file-contents note-file) + (re-search-forward (org-headline-re 1)) + (org-mode) ;Needed for `org-set-property'. + (org-set-property "seam-title-p" "t"))) + (seam-export--replace-variable + "backlinks" + (seam-export--generate-backlinks note-file)) + (write-file html-file)))) + +(defun seam-export--file-string (file) + (with-temp-buffer + (insert-file-contents file) + (buffer-string))) + +(defun seam-export-note (file) + (let ((type (seam-get-note-type file))) + (cl-loop for (dir . plist) in seam-export-alist + do + (let ((types (plist-get plist :types)) + (root-path (plist-get plist :root-path)) + (no-extension (plist-get plist :no-extension)) + (template-file (plist-get plist :template-file)) + (template-string (plist-get plist :template-string)) + (backend-options (plist-get plist :backend-options))) + (unless types + (error "You must specify :types for export")) + (let ((template + (cond + (template-file (seam-export--file-string template-file)) + (template-string template-string) + (seam-export-template-file (seam-export--file-string + seam-export-template-file)) + (seam-export-template-string seam-export-template-string) + (t (error "You must specify a template for export (see `seam-export-alist')"))))) + (when (member type types) + (let ((seam-export--types types) + (seam-export--root-path (or root-path "")) + (seam-export--no-extension no-extension) + (seam-export--template template) + (seam-export--options (org-combine-plists + seam-export-backend-options + backend-options))) + (seam-export--note-to-html file dir)))))))) + +(defun seam-export-all-notes () + "Export all note files as HTML." + (interactive) + (unless seam-export-alist + (error "Nothing to export. Please configure `seam-export-alist'.")) + (dolist (dir (seam-note-subdirectories)) + (dolist (file (directory-files dir t seam-note-file-regexp)) + (seam-export-note file)))) + +(provide 'seam-export) + +;;; seam-export.el ends here diff --git a/seam-html.el b/seam-html.el new file mode 100644 index 0000000..8f4731c --- /dev/null +++ b/seam-html.el @@ -0,0 +1,363 @@ +;;; seam-html.el --- Seam HTML exporter -*- lexical-binding: t -*- + +;; Copyright (c) 2025 Spencer Williams + +;; Author: Spencer Williams <spnw@plexwave.org> + +;; SPDX-License-Identifier: GPL-3.0-or-later + +;; This file is not part of GNU Emacs. + +;; This program is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see <http://www.gnu.org/licenses/>. + +;;; Commentary: + +;; Seam's HTML exporter. +;; +;; This was blithely hacked together using large chunks of code lifted +;; straight from ox-html.el, and could do with much improvement. +;; +;; Original ox-html code is licensed under GPL v3+. Copyright (c) +;; 2011-2025 Free Software Foundation, Inc. Original authors: Carsten +;; Dominik <carsten.dominik@gmail.com> and Jambunathan K <kjambunathan +;; at gmail dot com>. + +;;; Code: + +(require 'ox-html) + +;;; NOTE: This function does not respect `:headline-levels' or +;;; `:html-self-link-headlines'. +(defun seam-html-headline (headline contents info) + "Transcode a HEADLINE element from Org to HTML. +CONTENTS holds the contents of the headline. INFO is a plist +holding contextual information." + (cond + ((org-element-property :SEAM-TITLE-P headline) + contents) + ((org-element-property :footnote-section-p headline) + nil) + (t + (let* ((level (+ (org-export-get-relative-level headline info) + (1- (plist-get info :html-toplevel-hlevel)))) + (text (org-export-data (org-element-property :title headline) info)) + (contents (or contents "")) + (id (org-html--reference headline info)) + (todo (and (plist-get info :with-todo-keywords) + (let ((todo (org-element-property :todo-keyword headline))) + (and todo (org-export-data todo info))))) + (todo-type (and todo (org-element-property :todo-type headline))) + (priority (and (plist-get info :with-priority) + (org-element-property :priority headline))) + (tags (and (plist-get info :with-tags) + (org-export-get-tags headline info))) + (full-text (funcall (plist-get info :html-format-headline-function) + todo todo-type priority text tags info))) + (let ((headline-class + (org-element-property :HTML_HEADLINE_CLASS headline))) + (format "%s%s\n" + (format "<h%d id=\"%s\"%s>%s</h%d>\n" + level + id + (if (not headline-class) "" + (format " class=\"%s\"" headline-class)) + full-text + level) + contents)))))) + +(defun seam-html-section (_section contents _info) + "Transcode a SECTION element from Org to HTML. +CONTENTS holds the contents of the section." + contents) + +(defvar seam-html-standalone-image-predicate) +(defun seam-html-standalone-image-p (element info) + "Non-nil if ELEMENT is a standalone image. + +INFO is a plist holding contextual information. + +An element or object is a standalone image when + + - its type is `paragraph' and its sole content, save for white + spaces, is a link that qualifies as an inline image; + + - its type is `link' and its containing paragraph has no other + content save white spaces. + +Bind `seam-html-standalone-image-predicate' to constrain paragraph +further. For example, to check for only captioned standalone +images, set it to: + + (lambda (paragraph) (org-element-property :caption paragraph))" + (let ((paragraph (pcase (org-element-type element) + (`paragraph element) + (`link (org-element-parent element))))) + (and (org-element-type-p paragraph 'paragraph) + (or (not (and (boundp 'seam-html-standalone-image-predicate) + (fboundp seam-html-standalone-image-predicate))) + (funcall seam-html-standalone-image-predicate paragraph)) + (catch 'exit + (let ((link-count 0)) + (org-element-map (org-element-contents paragraph) + (cons 'plain-text org-element-all-objects) + (lambda (obj) + (when (pcase (org-element-type obj) + (`plain-text (org-string-nw-p obj)) + (`link (or (> (cl-incf link-count) 1) + (not (org-html-inline-image-p obj info)))) + (_ t)) + (throw 'exit nil))) + info nil 'link) + (= link-count 1)))))) + +(defun seam-html-link (link desc info) + "Transcode a LINK object from Org to HTML. +DESC is the description part of the link, or the empty string. +INFO is a plist holding contextual information. See +`org-export-data'." + (let* ((html-ext (plist-get info :html-extension)) + (dot (when (> (length html-ext) 0) ".")) + (link-org-files-as-html-maybe + (lambda (raw-path info) + ;; Treat links to `file.org' as links to `file.html', if + ;; needed. See `org-html-link-org-files-as-html'. + (save-match-data + (cond + ((and (plist-get info :html-link-org-files-as-html) + (let ((case-fold-search t)) + (string-match "\\(.+\\)\\.org\\(?:\\.gpg\\)?$" raw-path))) + (concat (match-string 1 raw-path) dot html-ext)) + (t raw-path))))) + (link-type (org-element-property :type link)) + (raw-path (org-element-property :path link)) + ;; Ensure DESC really exists, or set it to nil. + (desc (org-string-nw-p desc)) + (path + (cond + ((string= "seam" link-type) + (let ((slug raw-path)) + (when-let ((file (seam-lookup-slug slug))) + (let ((type (seam-get-note-type file))) + (when (and (member type seam-export--types) + (file-exists-p (seam-make-file-name slug type))) + (concat seam-export--root-path + slug + (if seam-export--no-extension "" ".html"))))))) + ((string= "file" link-type) + ;; During publishing, turn absolute file names belonging + ;; to base directory into relative file names. Otherwise, + ;; append "file" protocol to absolute file name. + (setq raw-path + (org-export-file-uri + (org-publish-file-relative-name raw-path info))) + ;; Possibly append `:html-link-home' to relative file + ;; name. + (let ((home (and (plist-get info :html-link-home) + (org-trim (plist-get info :html-link-home))))) + (when (and home + (plist-get info :html-link-use-abs-url) + (not (file-name-absolute-p raw-path))) + (setq raw-path (concat (file-name-as-directory home) raw-path)))) + ;; Maybe turn ".org" into ".html". + (setq raw-path (funcall link-org-files-as-html-maybe raw-path info)) + ;; Add search option, if any. A search option can be + ;; relative to a custom-id, a headline title, a name or + ;; a target. + (let ((option (org-element-property :search-option link))) + (if (not option) raw-path + (let ((path (org-element-property :path link))) + (concat raw-path + "#" + (org-publish-resolve-external-link option path t)))))) + (t (url-encode-url (concat link-type ":" raw-path))))) + (attributes-plist + (org-combine-plists + ;; Extract attributes from parent's paragraph. HACK: Only + ;; do this for the first link in parent (inner image link + ;; for inline images). This is needed as long as + ;; attributes cannot be set on a per link basis. + (let* ((parent (org-element-parent-element link)) + (link (let ((container (org-element-parent link))) + (if (and (org-element-type-p container 'link) + (org-html-inline-image-p link info)) + container + link)))) + (and (eq link (org-element-map parent 'link #'identity info t)) + (org-export-read-attribute :attr_html parent))) + ;; Also add attributes from link itself. Currently, those + ;; need to be added programmatically before `org-html-link' + ;; is invoked, for example, by backends building upon HTML + ;; export. + (org-export-read-attribute :attr_html link))) + (attributes + (let ((attr (org-html--make-attribute-string attributes-plist))) + (if (org-string-nw-p attr) (concat " " attr) "")))) + (cond + ;; Link type is handled by a special function. + ((org-export-custom-protocol-maybe link desc 'html info)) + ;; Image file. + ((and (plist-get info :html-inline-images) + (org-export-inline-image-p + link (plist-get info :html-inline-image-rules))) + (org-html--format-image path attributes-plist info)) + ;; Radio target: Transcode target's contents and use them as + ;; link's description. + ((string= link-type "radio") + (let ((destination (org-export-resolve-radio-link link info))) + (if (not destination) desc + (format "<a href=\"#%s\"%s>%s</a>" + (org-export-get-reference destination info) + attributes + desc)))) + ;; Links pointing to a headline: Find destination and build + ;; appropriate referencing command. + ((member link-type '("custom-id" "fuzzy" "id")) + (let ((destination (if (string= link-type "fuzzy") + (org-export-resolve-fuzzy-link link info) + (org-export-resolve-id-link link info)))) + (pcase (org-element-type destination) + ;; ID link points to an external file. + (`plain-text + (let ((fragment (concat org-html--id-attr-prefix raw-path)) + ;; Treat links to ".org" files as ".html", if needed. + (path (funcall link-org-files-as-html-maybe + destination info))) + (format "<a href=\"%s#%s\"%s>%s</a>" + path fragment attributes (or desc destination)))) + ;; Fuzzy link points nowhere. + (`nil + (;; format "<i>%s</i>" + identity + (or desc + (org-export-data + (org-element-property :raw-link link) info)))) + ;; Link points to a headline. + (`headline + (let ((href (org-html--reference destination info)) + ;; What description to use? + (desc + ;; Case 1: Headline is numbered and LINK has no + ;; description. Display section number. + (if (and (org-export-numbered-headline-p destination info) + (not desc)) + (mapconcat #'number-to-string + (org-export-get-headline-number + destination info) ".") + ;; Case 2: Either the headline is un-numbered or + ;; LINK has a custom description. Display LINK's + ;; description or headline's title. + (or desc + (org-export-data + (org-element-property :title destination) info))))) + (format "<a href=\"#%s\"%s>%s</a>" href attributes desc))) + ;; Fuzzy link points to a target or an element. + (_ + (if (and destination + (memq (plist-get info :with-latex) '(mathjax t)) + (org-element-type-p destination 'latex-environment) + (eq 'math (org-latex--environment-type destination))) + ;; Caption and labels are introduced within LaTeX + ;; environment. Use "ref" or "eqref" macro, depending on user + ;; preference to refer to those in the document. + (format (plist-get info :html-equation-reference-format) + (org-html--reference destination info)) + (let* ((ref (org-html--reference destination info)) + (seam-html-standalone-image-predicate + #'org-html--has-caption-p) + (counter-predicate + (if (org-element-type-p destination 'latex-environment) + #'org-html--math-environment-p + #'org-html--has-caption-p)) + (number + (cond + (desc nil) + ((seam-html-standalone-image-p destination info) + (org-export-get-ordinal + (org-element-map destination 'link #'identity info t) + info '(link) 'seam-html-standalone-image-p)) + (t (org-export-get-ordinal + destination info nil counter-predicate)))) + (desc + (cond (desc) + ((not number) "No description for this link") + ((numberp number) (number-to-string number)) + (t (mapconcat #'number-to-string number "."))))) + (format "<a href=\"#%s\"%s>%s</a>" ref attributes desc))))))) + ;; Coderef: replace link with the reference name or the + ;; equivalent line number. + ((string= link-type "coderef") + (let ((fragment (concat "coderef-" (org-html-encode-plain-text raw-path)))) + (format "<a href=\"#%s\" %s%s>%s</a>" + fragment + (format "class=\"coderef\" onmouseover=\"CodeHighlightOn(this, \ +'%s');\" onmouseout=\"CodeHighlightOff(this, '%s');\"" + fragment fragment) + attributes + (format (org-export-get-coderef-format raw-path desc) + (org-export-resolve-coderef raw-path info))))) + ;; External link with a description part. + ((and path desc) + (format "<a href=\"%s\"%s>%s</a>" + (org-html-encode-plain-text path) + attributes + desc)) + ;; External link without a description part. + (path + (let ((path (org-html-encode-plain-text path))) + (format "<a href=\"%s\"%s>%s</a>" path attributes path))) + ;; No path, only description. + (t desc)))) + + +(defun seam-html-src-block (src-block _contents info) + "Transcode a SRC-BLOCK element from Org to HTML. +CONTENTS holds the contents of the item. INFO is a plist holding +contextual information." + (if (org-export-read-attribute :attr_html src-block :textarea) + (org-html--textarea-block src-block) + (let* ((lang (org-element-property :language src-block)) + (code (org-html-format-code src-block info)) + (label (let ((lbl (org-html--reference src-block info t))) + (if lbl (format " id=\"%s\"" lbl) "")))) + (format "<pre>%s%s</pre>" + ;; Build caption. + (let ((caption (org-export-get-caption src-block))) + (if (not caption) "" + (let ((listing-number + (format + "<span class=\"listing-number\">%s </span>" + (format + (org-html--translate "Listing %d:" info) + (org-export-get-ordinal + src-block info nil #'org-html--has-caption-p))))) + (format "<label class=\"org-src-name\">%s%s</label>" + listing-number + (org-trim (org-export-data caption info)))))) + ;; Contents. + (format "<code class=\"src src-%s\"%s>%s</code>" + ;; Lang being nil is OK. + lang label code))))) + +(org-export-define-derived-backend + 'seam + 'html + :translate-alist + `((headline . seam-html-headline) + (link . seam-html-link) + (section . seam-html-section) + (src-block . seam-html-src-block))) + +(provide 'seam-html) + +;;; seam-html.el ends here diff --git a/seam-test.el b/seam-test.el new file mode 100644 index 0000000..e2ff971 --- /dev/null +++ b/seam-test.el @@ -0,0 +1,402 @@ +;;; seam-test.el --- Tests for Seam -*- lexical-binding: t -*- + +;; Copyright (c) 2025 Spencer Williams + +;; Author: Spencer Williams <spnw@plexwave.org> + +;; SPDX-License-Identifier: GPL-3.0-or-later + +;; This file is not part of GNU Emacs. + +;; This program is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see <http://www.gnu.org/licenses/>. + +;;; Commentary: + +;; Tests for Seam. + +;;; Code: + +;;; FIXME: Tests can fail if certain buffer names are already in use +;;; on the test runner's system. + +(require 'seam) +(require 'seam-export) +(require 'ert) +(require 'cl-lib) + +(defvar seam-test-directory nil) + +(defmacro seam-test-environment (&rest body) + (declare (indent 0)) + `(let* ((seam-test-directory (make-temp-file "seam-test" t)) + (seam-note-directory seam-test-directory) + (default-directory seam-test-directory) + (seam-note-types '("private" "public")) + (seam-default-note-type "private") + (seam-title-formatter (lambda (title _type) title)) + (seam-export-template-file nil) + (seam-export-template-string seam-export-default-template-string) + (seam-export-alist + `((,(file-name-concat seam-test-directory "html") + :types ("public") + :root-path "/"))) + ;; Manually install hooks in test directory. + (dir-locals-directory-cache + (cons (list seam-test-directory 'seam-note-directory nil) + dir-locals-directory-cache))) + (unwind-protect + (progn ,@body) + (delete-directory seam-test-directory t)))) + +(defmacro seam-test-with-notes (options varlist &rest body) + (declare (indent 2)) + `(seam-test-environment + (let ,options + (let ,(cl-loop for (name . args) in varlist + collect `(,name (seam-make-note ,@args))) + (unwind-protect (progn ,@body) + (mapcar #'kill-buffer (list ,@(mapcar #'car varlist)))))))) + +(defun seam-test-remove-testdir (filename) + (string-remove-prefix (concat seam-test-directory "/") filename)) + +(defun seam-test-list-files () + (mapcar + #'seam-test-remove-testdir + (directory-files-recursively seam-test-directory ""))) + +(defun seam-test-add-contents (buffer contents) + (with-current-buffer buffer + (insert contents) + (insert "\n") + (save-buffer))) + +(defun seam-test-replace-contents (buffer contents) + (with-current-buffer buffer + (erase-buffer) + (insert contents) + (insert "\n") + (save-buffer))) + +(defun seam-test-link-to-buffer (buffer) + (format "[[seam:%s]]" (file-name-base (buffer-file-name buffer)))) + +(defun seam-test-links-from-html (file) + (with-temp-buffer + (insert-file-contents file) + (delete-dups + (cl-loop for ret = (re-search-forward "<a href=\"/\\(.*\\)?\">" nil t) + while ret collect (match-string 1))))) + +(ert-deftest seam-test-make-note-private () + (should + (equal + '("private/note.org") + (seam-test-with-notes () + ((note "Note")) + (seam-test-list-files))))) + +(ert-deftest seam-test-make-note-public () + (should + (equal + '("html/note.html" "public/note.org") + (seam-test-with-notes () + ((note "Note" "public")) + (seam-test-list-files))))) + +(ert-deftest seam-test-make-note-weird-filename () + (should + (equal + '("./Weird file name!" ("private/weird-file-name.org")) + (seam-test-with-notes () + ((weird "./Weird file name! ")) + (list (buffer-name weird) + (seam-test-list-files)))))) + +(ert-deftest seam-test-get-title-from-buffer () + (seam-test-with-notes () ((note "Note")) + (should + (equal + (buffer-name note) + (seam-get-title-from-buffer note))))) + +(ert-deftest seam-test-get-title-from-file () + (seam-test-with-notes () ((note "Note")) + (should + (equal + (buffer-name note) + (seam-get-title-from-file (buffer-file-name note)))))) + +(ert-deftest seam-test-make-note-invalid-type () + (should-error + (seam-test-environment + (kill-buffer (seam-make-note "Note" "invalid-type"))))) + +(ert-deftest seam-test-make-note-name-conflict () + (should-error + (seam-test-environment + (kill-buffer (seam-make-note " Note 1 ")) + (kill-buffer (seam-make-note "Note_1"))))) + +(ert-deftest seam-test-make-note-name-conflict-different-types () + (should-error + (seam-test-environment + (kill-buffer (seam-make-note "Note")) + (kill-buffer (seam-make-note "Note" "public"))))) + +(ert-deftest seam-test-rename-note () + (should + (equal + '("New name" ("private/new-name.org")) + (seam-test-with-notes () ((note "Note")) + (with-current-buffer note + (erase-buffer) + (insert "* New name\n") + (save-buffer) + (list (buffer-name) (seam-test-list-files))))))) + +(ert-deftest seam-test-rename-conflict () + (should-error + (seam-test-with-notes () + (let ((note1 "Note 1") + (note2 "Note 2")) + (with-current-buffer note2 + (erase-buffer) + (insert "* note_1!\n") + (unwind-protect + (save-buffer) + (set-buffer-modified-p nil))))))) + +(ert-deftest seam-test-buffer-name-format-default () + (should + (equal + "Note (private)" + (seam-test-with-notes ((seam-title-formatter #'seam-format-title-default)) + ((note "Note")) + (buffer-name note))))) + +(ert-deftest seam-test-buffer-name-format-custom () + (should + (equal + "[private] Note" + (seam-test-with-notes ((seam-title-formatter + (lambda (title type) (format "[%s] %s" type title)))) + ((note "Note")) + (buffer-name note))))) + +(ert-deftest seam-test-link-update () + "Test that renaming a note updates its HTML and that of notes which link to it." + (should + (equal '(("qux.html") + ("public/qux.org") + ("html/foo.html" "html/qux.html" "public/foo.org" "public/qux.org")) + (seam-test-with-notes () + ((foo "foo" "public") + (bar "bar" "public")) + (progn + (seam-test-add-contents foo (seam-test-link-to-buffer bar)) + (seam-test-replace-contents bar "* qux") + (list + (seam-test-links-from-html "html/foo.html") + (mapcar #'seam-test-remove-testdir (seam-get-links-from-file (buffer-file-name foo))) + (seam-test-list-files))))))) + +(ert-deftest seam-test-link-to-private () + "Test that a private link does not get exported in HTML." + (should-error + (seam-test-with-notes () + ((foo "foo" "public") + (bar "bar")) + (seam-test-add-contents foo (seam-test-link-to-buffer bar)) + (with-temp-buffer + (insert-file-contents "html/foo.html") + (buffer-string) + (re-search-forward "<a href=\"/bar.html\">"))))) + +(ert-deftest seam-test-link-no-extension () + "Test that the :no-extension option causes links to render without .html +extension." + (should + (identity + (seam-test-with-notes ((seam-export-alist + `((,(file-name-concat seam-test-directory "html") + :types ("public") + :root-path "/" + :no-extension t)))) + ((foo "foo" "public") + (bar "bar" "public")) + (seam-test-add-contents foo (seam-test-link-to-buffer bar)) + (with-temp-buffer + (insert-file-contents "html/foo.html") + (buffer-string) + (re-search-forward "<a href=\"/bar\">")))))) + +(ert-deftest seam-test-link-getters () + (should + (equal + '(("private/bar.org" "private/qux.org") + ("private/foo.org") + ("private/bar.org" "private/foo.org")) + (seam-test-with-notes () + ((foo "foo") + (bar "bar") + (qux "qux")) + (seam-test-add-contents foo (seam-test-link-to-buffer bar)) + (seam-test-add-contents foo (seam-test-link-to-buffer qux)) + (seam-test-add-contents bar (seam-test-link-to-buffer qux)) + (list + (mapcar #'seam-test-remove-testdir (seam-get-links-from-file (buffer-file-name foo))) + (mapcar #'seam-test-remove-testdir (seam-get-links-to-file (buffer-file-name bar))) + (mapcar #'seam-test-remove-testdir (seam-get-links-to-file (buffer-file-name qux)))))))) + +(ert-deftest seam-test-delete-note () + "Test that deleting a note also deletes its HTML and re-exports linking +notes such that they no longer link to it." + (should + (equal + '(nil ("html/foo.html" "public/foo.org")) + (seam-test-with-notes () + ((foo "foo" "public") + (bar "bar" "public")) + (with-current-buffer foo + (seam-test-add-contents foo (seam-test-link-to-buffer bar))) + (let ((delete-by-moving-to-trash nil)) + (seam-delete-note (buffer-file-name bar))) + (list + (seam-test-links-from-html "html/foo.html") + (seam-test-list-files)))))) + +(ert-deftest seam-test-backlinks-public () + "Test that linking to a note from a public note creates a backlink." + (should + (identity + (seam-test-with-notes ((seam-export-template-string "{{backlinks}}")) + ((foo "foo" "public") + (bar "bar" "public")) + (with-current-buffer foo + (seam-test-add-contents foo (seam-test-link-to-buffer bar))) + (with-temp-buffer + (insert-file-contents "html/bar.html") + (re-search-forward "<a href=\"/foo.html\">")))))) + +(ert-deftest seam-test-backlinks-private () + "Test that linking to a note from a private note does not create a +backlink." + (should-error + (seam-test-with-notes ((seam-export-template-string "{{backlinks}}")) + ((foo "foo") + (bar "bar" "public")) + (with-current-buffer foo + (seam-test-add-contents foo (seam-test-link-to-buffer bar))) + (with-temp-buffer + (insert-file-contents "html/bar.html") + (re-search-forward "<a href=\"/foo.html\">"))))) + +(ert-deftest seam-test-backlinks-delete () + "Test that deleting a note removes backlink." + (should-error + (seam-test-with-notes ((seam-export-template-string "{{backlinks}}")) + ((foo "foo" "public") + (bar "bar" "public")) + (with-current-buffer foo + (seam-test-add-contents foo (seam-test-link-to-buffer bar))) + (let ((delete-by-moving-to-trash nil)) + (seam-delete-note (buffer-file-name foo))) + (with-temp-buffer + (insert-file-contents "html/bar.html") + (re-search-forward "<a href=\"/foo.html\">"))))) + +(ert-deftest seam-test-set-type-private () + "Test that setting a public note to private will delete its HTML file and +update linking HTML files such that they no longer link to it." + (should + (equal + '(nil ("html/foo.html" "private/bar.org" "public/foo.org")) + (seam-test-with-notes () + ((foo "foo" "public") + (bar "bar" "public")) + (with-current-buffer foo + (seam-test-add-contents foo (seam-test-link-to-buffer bar))) + (seam-set-note-type (buffer-file-name bar) "private") + (list + (seam-test-links-from-html "html/foo.html") + (seam-test-list-files)))))) + +(ert-deftest seam-test-set-type-public () + "Test that setting a private note to public will export its HTML file and +update linking HTML files such that they link to it." + (should + (equal + '(("bar.html") + ("html/bar.html" "html/foo.html" "public/bar.org" "public/foo.org")) + (seam-test-with-notes () + ((foo "foo" "public") + (bar "bar")) + (with-current-buffer foo + (seam-test-add-contents foo (seam-test-link-to-buffer bar))) + (seam-set-note-type (buffer-file-name bar) "public") + (list + (seam-test-links-from-html "html/foo.html") + (seam-test-list-files)))))) + +(ert-deftest seam-test-set-type-invalid () + "Test that setting a note to an invalid type raises an error." + (should-error + (seam-test-with-notes () + ((foo "foo")) + (seam-set-note-type (buffer-file-name foo) "invalid-type")))) + +(ert-deftest seam-test-follow-link-existing () + "Test that following a link to an existing note opens that note." + (should + (equal + "bar" + (seam-test-with-notes () + ((foo "foo") + (bar "bar")) + (with-current-buffer foo + (seam-test-add-contents foo "[[seam:bar]]") + (org-previous-link) + (org-open-at-point) + (buffer-name)))))) + +(ert-deftest seam-test-follow-link-new () + "Test that following a link to an nonexistent note creates and opens that note." + (should + (equal + '("bar" ("private/bar.org" "private/foo.org")) + (seam-test-with-notes () + ((foo "foo")) + (with-current-buffer foo + (seam-test-add-contents foo "[[seam:bar]]") + (goto-char 1) + (org-next-link) + (org-open-at-point) + (unwind-protect + (list + (buffer-name) + (seam-test-list-files)) + (kill-buffer))))))) + +(ert-deftest seam-test-escape-title () + (should + (equal + "“quotes” & <symbols>\n" + (seam-test-with-notes ((seam-export-template-string "{{title}}")) + ((note "\"quotes\" & <symbols>" "public")) + (seam-export--file-string "html/quotes-symbols.html"))))) + +(provide 'seam-test) + +;;; seam-test.el ends here @@ -0,0 +1,568 @@ +;;; seam.el --- Personal Org mode wiki -*- lexical-binding: t; -*- + +;; Copyright (c) 2025 Spencer Williams + +;; Author: Spencer Williams <spnw@plexwave.org> +;; Homepage: https://wiki.plexwave.org/seam +;; Keywords: hypermedia, outlines + +;; Version: 0.1.0 + +;; SPDX-License-Identifier: GPL-3.0-or-later + +;; This file is not part of GNU Emacs. + +;; This program is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see <http://www.gnu.org/licenses/>. + +;;; Commentary: + +;; Seam is a package that lets you easily create, link, and publish +;; Org notes in the form of a personal wiki. + +;;; Code: + +(require 'seam-export) +(require 'cl-lib) +(require 'grep) + +(defgroup seam nil + "Options for Seam." + :group 'org + :tag "Seam") + +(defcustom seam-note-directory nil + "Seam note directory." + :group 'seam + :type '(choice directory (const nil))) + +(defcustom seam-default-note-type "private" + "Default type for Seam notes." + :group 'seam + :type 'string) + +(defcustom seam-note-types '("private" "public") + "Seam note types." + :group 'seam + :type '(repeat string)) + +(defun seam-format-title-default (title type) + "Default Seam title formatter. Formats like this: \"TITLE (TYPE)\"." + (format "%s %s" title (propertize (format "(%s)" type) 'face 'font-lock-comment-face))) + +(defcustom seam-title-formatter + #'seam-format-title-default + "Function used by Seam to format note titles for completion and buffer +naming. Must be a function taking two arguments: TITLE and TYPE." + :group 'seam + :type 'function) + +(defun seam-html-directories () + (mapcar #'car seam-export-alist)) + +(defun seam-lookup-slug (slug) + (cl-dolist (type seam-note-types) + (let ((file (file-name-concat seam-note-directory type (concat slug ".org")))) + (when (file-exists-p file) + (cl-return (expand-file-name file)))))) + +(defun seam--check-conflict (title) + (when (seam-lookup-slug (seam-slugify title)) + (error "`%s' would conflict with an existing note" title))) + +(defun seam-link-open (path _prefix) + (org-mark-ring-push) + (if-let ((file (seam-lookup-slug path))) + (find-file file) + (seam-make-note path nil t)) + (seam-set-buffer-name)) + +(defvar seam-note-file-regexp "\\`[^.].+\\.org\\'") +(defvar seam--subset nil) + +(defcustom seam-completing-read-function #'completing-read + "The completion function used by Seam." + :group 'seam + :type 'function) + +(defun seam-ensure-directory-exists (dir) + (unless (file-directory-p dir) + (make-directory dir t))) + +(defun seam-ensure-note-subdirectories-exist () + (unless seam-note-directory + (error "Please set `seam-note-directory'")) + (cl-dolist (type seam-note-types) + (let ((dir (file-name-concat seam-note-directory type))) + (seam-ensure-directory-exists dir)))) + +(defcustom seam-sort-method 'title + "The method used by Seam to sort notes." + :group 'seam + :type '(choice (const :tag "Sort by title" title) + (const :tag "Sort by modification date" modified))) + +(cl-defgeneric seam-get-all-notes (sort-by)) + +(cl-defmethod seam-get-all-notes ((sort-by (eql 't))) + (ignore sort-by) + (seam-get-all-notes seam-sort-method)) + +(cl-defmethod seam-get-all-notes ((sort-by (eql 'modified))) + (ignore sort-by) + (let ((files (cl-loop for type in (seam--active-subset) + append (directory-files-and-attributes + (file-name-concat seam-note-directory type) + t + seam-note-file-regexp)))) + (cl-loop for (file . _attributes) + in (cl-sort + files + (lambda (f1 f2) + (time-less-p (file-attribute-modification-time f2) + (file-attribute-modification-time f1))) + :key #'cdr) + collect (cons (seam-get-title-from-file file) file)))) + +(cl-defmethod seam-get-all-notes ((sort-by (eql 'title))) + (ignore sort-by) + (let ((files (cl-loop for type in (seam--active-subset) + append (directory-files + (file-name-concat seam-note-directory type) + t + seam-note-file-regexp)))) + (cl-sort + (cl-loop for file in files + collect (cons (seam-get-title-from-file file) file)) + #'string< + :key #'car))) + +(cl-defun seam-get-title-from-buffer (&optional (buffer (current-buffer))) + (with-current-buffer buffer + (save-mark-and-excursion + (save-restriction + (goto-char 1) + (ignore-errors + (re-search-forward (org-headline-re 1)) + (let ((start (point))) + (end-of-line) + (let ((title (string-trim (buffer-substring-no-properties start (point))))) + (unless (string-empty-p title) + title)))))))) + +(defun seam-get-title-from-file (file) + (with-temp-buffer + (insert-file-contents file) + (seam-get-title-from-buffer))) + +(defun seam-format-title (title type) + (funcall seam-title-formatter title type)) + +(defun seam--completing-read (&rest args) + (let ((completion-ignore-case t)) + (apply seam-completing-read-function args))) + +(defun seam-slugify (title) + (downcase (string-join (string-split title "\\W+" t) "-"))) + +(defun seam-make-note (title &optional type select) + (unless type + (setq type seam-default-note-type)) + (unless (member type seam-note-types) + (error "`%s' is not a valid Seam note type" type)) + (seam-ensure-note-subdirectories-exist) + (let ((file (file-name-concat seam-note-directory + type + (concat (seam-slugify title) ".org")))) + (seam--check-conflict title) + (let ((buffer (funcall (if select #'find-file #'find-file-noselect) file))) + (with-current-buffer buffer + (insert (format "* %s\n" title)) + (save-buffer) + buffer)))) + +(defun seam-read-title (prompt) + (seam-ensure-note-subdirectories-exist) + (let* ((notes (seam-get-all-notes t)) + (self (cl-find (buffer-file-name) notes :key #'cdr :test #'equal))) + (let ((notes + (append (cl-remove self + notes + :test #'equal) + (and self (list self))))) + (let ((files (cl-loop for (title . file) in notes + collect (cons (seam-format-title title (seam-get-note-type file)) file)))) + (let ((completion (string-trim (seam--completing-read prompt files)))) + (or (assoc completion files) + (cons completion nil))))))) + +(defun seam--read-type (prompt arg &optional choices) + (when arg + (if (listp arg) + (seam--completing-read prompt (or choices seam-note-types) nil t) + (nth (1- arg) seam-note-types)))) + +;;;###autoload +(defun seam-find-note (arg) + "Find Seam note interactively by title, creating it if it does not exist. +`seam-completing-read-function' is used for completion. + +A prefix argument can be used to show only a specific note type (and to +use that type if a new note is created). With a numeric argument N, the +Nth type in `seam-note-types' is chosen (counting from 1). With C-u, a +completion prompt is given to choose the type." + (interactive "P") + (let* ((type (seam--read-type "Type: " arg)) + (seam--subset + (if type (list type) seam-note-types))) + (cl-destructuring-bind (completion . file) + (seam-read-title "Open note: ") + (if file + (with-current-buffer (find-file file) + ;; Ensure buffer name is up to date (e.g. after changing + ;; formatter function) (NOTE: Redundant if buffer wasn't + ;; already open, as `seam-setup-buffer' does this too.) + (seam-set-buffer-name)) + (seam-make-note (string-trim completion) (or type seam-default-note-type) t))))) + +(cl-defun seam-get-note-type (file &optional no-error) + (when (and file (equal "org" (file-name-extension file))) + (let ((type (cadr (nreverse (file-name-split file))))) + (when (member type seam-note-types) + (cl-return-from seam-get-note-type type)))) + (unless no-error + (error "%s is not a Seam note" file))) + +(defun seam-make-file-name (slug type) + (expand-file-name + (file-name-concat + seam-note-directory type + (concat slug ".org")))) + +(defun seam-get-links-to-file (file) + "Return filename of each note which links to FILE." + (remove (expand-file-name file) + (seam-note-files-containing-string (format "[[seam:%s]" (file-name-base file))))) + +(defun seam-get-links-from-file (file) + "Return filename of each existing note which is linked to from FILE." + (let ((links + (with-temp-buffer + (insert-file-contents file) + (delete-dups + (cl-loop for ret = (re-search-forward "\\[\\[seam:\\(.*?\\)\\]" nil t) + while ret collect (match-string 1)))))) + (remove (expand-file-name file) + (cl-loop for link in links + as f = (seam-lookup-slug link) + when f collect f)))) + +(defun seam-delete-html-files-for-note (note-file) + (dolist (dir (seam-html-directories)) + (let ((html (file-name-concat dir (concat (file-name-base note-file) ".html")))) + (when (file-exists-p html) + (delete-file html) + (message "Deleted %s" html))))) + +(defun seam-post-save-or-rename (old new &optional previous-links-from-file) + (unless (string= old new) + (seam-update-links old new) + (seam-delete-html-files-for-note old) + (dolist (dir (seam-html-directories)) + (delete-file (file-name-concat dir (concat (file-name-base old) ".html"))))) + (seam-export-note new) + (let ((removed-links (cl-set-difference previous-links-from-file + (seam-get-links-from-file new) + :test #'string=))) + (mapc #'seam-export-note + (delete-dups + (append removed-links + (seam-get-links-from-file new) + ;; If our type changes, we cannot rely on + ;; `seam-update-links' to trigger a re-render of + ;; the pages that link to us, as types are not + ;; encoded in the link. + (unless (string= (seam-get-note-type old) + (seam-get-note-type new)) + (seam-get-links-to-file new))))))) + +(defun seam-save-buffer () + (let* ((old (buffer-file-name)) + (type (seam-get-note-type old t))) + (when type + (let* ((title (or (seam-get-title-from-buffer) + (error "Note must have a title"))) + (slug (seam-slugify title)) + (new (seam-make-file-name slug type))) + (unless (string= old new) ;This is valid because + ;`seam-save-buffer' cannot + ;change type. + (seam--check-conflict title) + (rename-file old new) + (set-visited-file-name new nil t)) + (let ((previous-links-from-file + ;; If we've yet to create the file, don't check it. + (when (file-exists-p new) + (seam-get-links-from-file new)))) + (let ((write-contents-functions + (remove 'seam-save-buffer write-contents-functions))) + (save-buffer)) + (seam-post-save-or-rename old new previous-links-from-file) + (seam-set-buffer-name) + t))))) + +(defun seam--set-note-type (file new-type) + (let ((old-type (seam-get-note-type file)) + (new-file (seam-make-file-name (file-name-base file) new-type))) + (if (string= new-type old-type) + file + (rename-file file new-file) + (seam-post-save-or-rename file new-file) + new-file))) + +;;;###autoload +(defun seam-set-note-type (file new-type &optional interactive) + "Set Seam note FILE to NEW-TYPE. Error if file is not a Seam note. + +When called interactively, FILE is the currently visited file. A +numeric argument N chooses the Nth type in `seam-note-types' (counting +from 1). Otherwise a completion prompt is given for the desired type." + (interactive + (let* ((file (buffer-file-name)) + (old-type (seam-get-note-type file))) + (list file + (or (seam--read-type "New type: " + ;; HACK: Treat nil prefix as C-u. + (or current-prefix-arg '(4)) + (remove old-type seam-note-types)) + old-type) + t))) + (let ((new-file (seam--set-note-type file new-type))) + (when interactive + (set-visited-file-name new-file nil t) + (seam-set-buffer-name)))) + +(defun seam-update-links (old new) + (let ((old-slug (file-name-base old)) + (new-slug (file-name-base new))) + (unless (string= old-slug new-slug) + (let ((count (seam-replace-string-in-notes + (format "[[seam:%s]" old-slug) + (format "[[seam:%s]" new-slug) + t))) + (unless (zerop count) + (message "Updated links in %d file%s" + count (if (= count 1) "" "s"))))))) + +(defun seam--active-subset () + (or seam--subset seam-note-types)) + +(defun seam-note-subdirectories () + (cl-loop for type in (seam--active-subset) + collect (expand-file-name + (file-name-as-directory + (file-name-concat seam-note-directory type))))) + +(defun seam-note-files-containing-string (string) + "Search all Seam note files for literal STRING. Case-sensitive." + (seam-ensure-note-subdirectories-exist) + (with-temp-buffer + (apply #'call-process find-program + nil t nil + (append + (seam-note-subdirectories) + (list "-type" "f" "-name" "*.org" "-and" "-not" "-name" ".*" + "-exec" grep-program "-F" "-l" "-s" "-e" string "{}" "+"))) + (string-lines (string-trim (buffer-string)) t))) + +;;;###autoload +(defun seam-search (query &optional delimited) + "Search all Seam notes for the regexp QUERY (case-insensitively). If +DELIMITED is non-nil, only search at word boundaries. + +When called interactively, DELIMITED is t if a prefix argument is given. +Otherwise, it's nil." + (interactive (list (read-string (format "Search all notes%s: " + (if current-prefix-arg + " for word" + ""))) + current-prefix-arg)) + (when (eq grep-highlight-matches 'auto-detect) + (grep-compute-defaults)) + (let ((default-directory seam-note-directory)) + (grep + (format "%s %s -type f -name %s -and -not -name %s -exec %s %s -n -i -e %s \\{\\} \\+" + find-program + (string-join (mapcar (lambda (type) + (shell-quote-argument (concat type "/"))) + seam-note-types) + " ") + (shell-quote-argument "*.org") + (shell-quote-argument ".*") + grep-program + (if grep-highlight-matches "--color=always" "") + (shell-quote-argument + (if delimited + (concat "\\b" query "\\b") + query)))))) + +(defun seam-visited-files () + (cl-loop for buf in (buffer-list) + as file = (buffer-file-name buf) + when (and file (file-in-directory-p file seam-note-directory)) + collect file)) + +(defun seam-replace-string-in-notes (old new preserve-modtime) + (let ((hash (make-hash-table :test 'equal))) + (dolist (file (seam-note-files-containing-string old)) + (puthash file nil hash)) + (dolist (file (seam-visited-files)) + (puthash file t hash)) + (let ((update-count 0)) + (maphash + (lambda (file was-open-p) + (with-current-buffer (find-file-noselect file) + (let ((was-modified-p (buffer-modified-p))) + (save-mark-and-excursion + (without-restriction + (goto-char (point-min)) + (let ((updated-p nil)) + (while (search-forward old nil t) + (setq updated-p t) + (replace-match new)) + (when updated-p + (setq update-count (1+ update-count)))))) + (when (and (not was-modified-p) + (buffer-modified-p)) + (if preserve-modtime + (let ((modtime (visited-file-modtime))) + (save-buffer) + (set-file-times file modtime) + (set-visited-file-modtime modtime)) + (save-buffer))) + (unless was-open-p + (kill-buffer))))) + hash) + update-count))) + +(cl-defun seam-set-buffer-name (&optional (buffer (current-buffer))) + (with-current-buffer buffer + (rename-buffer + (seam-format-title (seam-get-title-from-buffer) + (seam-get-note-type (buffer-file-name buffer)))))) + +(defun seam-setup-buffer () + "Setup hooks when loading a Seam file." + (add-hook 'write-contents-functions 'seam-save-buffer nil t) + ;; NOTE: Needed for when note w/o using Seam commands. Redundant otherwise. + (seam-set-buffer-name)) + +(defun seam--watch-note-directory-var (_symbol newval operation _where) + "Install necessary hooks when `seam-note-directory' is set, removing any +old ones." + (when (member operation '(set makunbound)) + (setq dir-locals-directory-cache + (cl-remove 'seam-note-directory dir-locals-directory-cache :key #'cadr)) + (when newval + (dir-locals-set-directory-class newval 'seam-note-directory)))) + +(defun seam--delete-note (file) + (seam-get-note-type file) ;Error if file isn't a Seam note. + (let ((to-update (delete-dups + (append + (seam-get-links-to-file file) + (seam-get-links-from-file file))))) + (delete-file file t) + (seam-delete-html-files-for-note file) + (mapc #'seam-export-note to-update))) + +;;;###autoload +(defun seam-delete-note (file &optional interactive) + "Delete Seam note FILE. Error if file is not a Seam note. +`delete-by-moving-to-trash' is respected. + +When called interactively, FILE is the currently visited file, and the +buffer is killed after deletion." + (interactive + (let ((file (buffer-file-name))) + (seam-get-note-type file) ;Error if file isn't a Seam note. + (list + (let ((incoming (length (seam-get-links-to-file file)))) + (and (yes-or-no-p + (format "Really %s file and kill buffer%s?" + (if delete-by-moving-to-trash + "trash" + "delete") + (if (> incoming 0) + (format " (breaking links from %d note%s)" + incoming + (if (= incoming 1) "" "s")) + ""))) + file)) + t))) + (unless (and interactive (null file)) + (seam--delete-note file) + (when interactive + (kill-buffer)))) + +;;;###autoload +(defun seam-insert-link () + "Interactively insert an Org link at point to the given Seam note, +creating the note if it does not exist. If any text is selected, the +link will replace it." + (interactive) + (cl-destructuring-bind (completion . file) (seam-read-title "Insert link: ") + (let* ((new-buffer + (unless file + (seam-make-note completion seam-default-note-type nil))) + (selection (when (use-region-p) + (buffer-substring + (region-beginning) + (region-end)))) + (file (if new-buffer + (buffer-file-name new-buffer) + file)) + (slug (file-name-base file)) + (initial (or selection + (seam-get-title-from-file file))) + (desc (read-string "Description: " initial))) + (when selection + (delete-region (region-beginning) (region-end))) + (insert (format "[[seam:%s][%s]]" slug desc)) + (when new-buffer + (pop-to-buffer new-buffer))))) + +(defvar-keymap seam-prefix-map + "f" #'seam-find-note + "k" #'seam-delete-note + "l" #'seam-insert-link + "s" #'seam-search + "t" #'seam-set-note-type) + +(org-link-set-parameters "seam" :follow #'seam-link-open) + +(dir-locals-set-class-variables + 'seam-note-directory + '((org-mode . ((eval . (seam-setup-buffer)))))) + +(add-variable-watcher 'seam-note-directory #'seam--watch-note-directory-var) + +;;; If `seam-note-directory' was set before loading package, ensure +;;; directory class is set up. +(when (and seam-note-directory + (not (cl-find 'seam-note-directory dir-locals-directory-cache :key #'cadr))) + (dir-locals-set-directory-class seam-note-directory 'seam-note-directory)) + +(provide 'seam) + +;;; seam.el ends here |