commit 0c3013c020d3817b5fec80ea8e3cc735ea680fed Author: TEC Date: Sun Aug 16 03:19:03 2020 +0800 Initial commit diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENCE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.org b/README.org new file mode 100644 index 0000000..c91bfdf --- /dev/null +++ b/README.org @@ -0,0 +1,70 @@ +#+TITLE: Org Pandoc Import +#+AUTHOR: tecosaur + +The worst part about =org-mode=? Having to leave it. + +This package aims to reduce this pain, in using two components: + 1. ~org-pandoc-import-{to,as}-org~ allows you to easily import supported non-org files with Pandoc + 2. ~org-pandoc-import-transient-mode~ which + - (via file handlers) intercepts requests for non-org files it knows it can convert + - uses ~org-pandoc-import-to-org~ to convert the file to a temporary org file + - opens this org file instead + - exports back to the original non-org file on save + +[[file:org-pandoc-import.svg]] + +* Screenshots + +[[file:screenshots/odt.png]] + +[[file:screenshots/markdown.png]] + +[[file:screenshots/csv.png]] + +* Default backends ++ markdown :: associated with: =.md=, =.markdown= ++ LaTeX :: associated with: =.tex=, =.latex= ++ reST :: (~rst~) associated with: =.rst= ++ ODT :: associated with: =.odt= ++ DOCX :: associated with: =.docx= ++ Jupyter Notebooks :: (~ipynb~) associated with: =.ipynb= ++ Rmarkdown :: (~markdown~) associated with: =.Rmd=, =.rmd= ++ CSV :: associated with: =.csv= ++ TSV :: (~csv~) associated with: =.tsv= + +** Default transient-mode backends +Please note that this mode is off by default. +It is however a global mode, so enable it once in your config and it will be +active everywhere. + +The active transient backends are determined by +~org-pandoc-import-transient-associations~. + ++ markdown :: using Org's ~gfm~ export if available, otherwise ~md~ ++ ODT :: using Org's ~odt~ export ++ csv, tsv :: using ~org-table-export~ +When ~ox-pandoc~ is avalible, the following formats are also enabled by default, +and use ~ox-pandoc~ to export. ++ rst ++ docx +* Adding new backends +For something supported out of the box by Pandoc, it couldn't be easier --- +just +#+BEGIN_SRC emacs-lisp +(org-pandoc-import-backend foo) +#+END_SRC + +This will add ~foo~ to ~org-pandoc-import-backends~, and create the following +functions ++ ~org-pandoc-import-foo-as-org~ ++ ~org-pandoc-import-foo-to-org~ +Which will reference these variables, ++ ~org-pandoc-import-foo-args~ ++ ~org-pandoc-import-foo-filters~ ++ ~org-pandoc-import-foo-preprocessors~ ++ ~org-pandoc-import-foo-extensions~ +That last variable will be set to ~("foo")~, and will cause +~org-pandoc-import-{to,as}-org~ to automatically select this backend when called +on =.foo= files. + +These all have docstrings --- check them out! diff --git a/filters/_simple-headers.lua b/filters/_simple-headers.lua new file mode 100644 index 0000000..254466c --- /dev/null +++ b/filters/_simple-headers.lua @@ -0,0 +1,39 @@ +local header_ids = {} + +local function collect_id (header) + if header.identifier and header.identifier ~= "" then + header_ids[header.identifier] = header.content + header.identifier = "" + return header + end +end + +local function raw_inlines (s) + return pandoc.List{pandoc.RawInline('org', s)} +end + +local function modify_link (link) + -- only modify internal links + if link.target:sub(1,1) ~= '#' then + return + end + local target_id = link.target:sub(2) + local header_content = header_ids[target_id] + if header_content then + return raw_inlines '[[*' + .. header_content + .. raw_inlines '][' + .. link.content + .. raw_inlines ']]' + end +end + +local function remove_id (header) + header.identifier = "" + return header +end + +return { + {Header = collect_id}, + {Link = modify_link}, +} diff --git a/filters/rmarkdown.lua b/filters/rmarkdown.lua new file mode 100644 index 0000000..ed0f9c6 --- /dev/null +++ b/filters/rmarkdown.lua @@ -0,0 +1,82 @@ +-- SPDX-License-Identifier: GPL-3.0-or-later + +local argKeywordTranslation = { + ["eval"] = "eval", + ["echo"] = "exports", + ["include"] = "exports", + ["purl"] = "tangle", + ["cache"] = "cache" +} + +local argValueTranslations = { + ["TRUE"] = "yes", + ["FALSE"] = "no", +} + +local argKeyValueTranslations = { + ["echo-FALSE"] = "results", + ["echo-TRUE"] = "both", + ["include-FALSE"] = "none", + ["include-TRUE"] = "both", +} + +local function reformatHeaderArgs(headerArgs) + local out = "" + for header in string.gmatch(headerArgs..",", "%s*([^,][^,]-)%s*,") do + local hKey = string.match(header, "^([^=][^=]-)%s*=") + local hVal = string.match(header, "=%s*(.-)%s*$") + local key = argKeywordTranslation[hKey] + local val + if hVal ~= nil then + val = argKeyValueTranslations[hKey.."-"..hVal] + end + if val == nil then + val = argValueTranslations[hVal] + end + if key ~= nil and val ~= nil then + out = out.." :"..key.." "..val + end + end + return out +end + +local function generateSrcInfo(body) + local beginTag = "#+BEGIN_SRC" + local endTag = "#+END_SRC" + if ("{" == string.sub(body, 1, 1)) then + local firstLine = string.match(body, "^([^\n]+)") + local lang = string.match(firstLine, "{%s*([^,]-)%s*[,}]") + if lang == nil then + lang = "" + local beginTag = "#+BEGIN_EXAMPLE" + local endTag = "#+END_EXAMPLE" + elseif lang == "r" then + lang = " R" + else + lang = " "..lang + end + local argsRaw = string.match(firstLine, "{[^,]+(.-)%s*}") + local args + if argsRaw ~= nil and argsRaw ~= "" then + args = reformatHeaderArgs(argsRaw) + else + args = argsRaw + end + body = string.gsub(body, "^[^\n]+\n", "") + return "\n"..beginTag..lang..args.."\n"..body.."\n"..endTag.."\n" + end + return "\n#+BEGIN_EXAMPLE\n"..body.."\n#+END_EXAMPLE\n" +end + +return { + { + Code = function(elem) + return elem + end + }, + { + CodeBlock = function(elem) + return pandoc.RawBlock("Org", generateSrcInfo(elem.text)) + end + } +} diff --git a/org-pandoc-import-transient.el b/org-pandoc-import-transient.el new file mode 100644 index 0000000..870b468 --- /dev/null +++ b/org-pandoc-import-transient.el @@ -0,0 +1,159 @@ +;;; org-pandoc-import-transient.el -*- lexical-binding: t; -*- + +;; SPDX-License-Identifier: GPL-3.0-or-later + +;; TODO add backups, better folder names, cleanup on emacs exit + +(require 'org-pandoc-import) +(require 'org) +(require 'ox-pandoc nil t) + +(defcustom org-import-transient-async-export nil + "Whether or not to use Org's async export mode. +This trades a short blocking period for a long non-blocking period." + :type 'list + :group 'org-pandoc-import) + +(defcustom org-pandoc-import-transient-associations + (append + `(("md" . ,(if (featurep 'ox-gfm) "gfm" "md")) + ("odt" . "odt") + ("csv" . (lambda () + (unless (org-at-table-p) + (user-error "Point is not inside a table.")) + (org-table-export (concat (file-name-base (buffer-file-name)) ".csv") + "orgtbl-to-csv"))) + ("tsv" . (lambda () + (unless (org-at-table-p) + (user-error "Point is not inside a table.")) + (org-table-export (concat (file-name-base (buffer-file-name)) ".tsv") + "orgtbl-to-tsv")))) + (when (featurep 'ox-pandoc) + '(("rst" . org-pandoc-export-to-rst) + ("docx" . org-pandoc-export-to-docx)))) + "An alist of file extensions, and associated exporters. +Exporters can either be a string correspanding to a particular org exporter, +or some funcion. +An importer backend that recognises the given extension must exist." + :type 'list + :group 'org-pandoc-import) + +;;;###autoload +(define-minor-mode org-pandoc-import-transient-mode + "On-the-fly convert other markups to org and back." + :global t + :init-value nil) + +(defun org-pandoc-import-transient--register-file-handlers () + "Modify `file-name-handler-alist' to have the transient handler associated with +active extensions." + (let* ((supported-extensions (mapcar #'car org-pandoc-import-transient-associations)) + (extension-regex (concat "\\." (regexp-opt supported-extensions) "\\'")) + (entry (rassoc 'org-pandoc-import-transient--file-handler file-name-handler-alist)) + (org-entry (rassoc 'org-pandoc-import-transient--maybe-converted-org-file-handler file-name-handler-alist)) + (org-transient-file-regex "\\.org\\+.+\\'") + (org-alist (assoc org-transient-file-regex auto-mode-alist))) + (if entry + (setcar entry extension-regex) + (nconc file-name-handler-alist (list (cons extension-regex #'org-pandoc-import-transient--file-handler)))) + (unless org-entry + (nconc file-name-handler-alist (list (cons org-transient-file-regex #'org-pandoc-import-transient--maybe-converted-org-file-handler)))) + (unless org-alist + (nconc auto-mode-alist (list (cons org-transient-file-regex #'org-mode)))))) + +(defun org-pandoc-import-transient--file-handler (operation &rest args) + (let ((inhibit-file-name-handlers + (cons 'org-pandoc-import-transient--file-handler + (and (eq inhibit-file-name-operation operation) + inhibit-file-name-handlers))) + (inhibit-file-name-operation operation)) + + (if org-pandoc-import-transient-mode + (if (eq operation 'expand-file-name) + (org-pandoc-import-transient--convert-file-name + (apply operation args)) + (apply operation args)) + (apply operation args)))) + +(defvar org-pandoc-import-transient--files nil + "Global alist of special files and their properties.") + +(defvar org-pandoc-import-transient--currently-processing nil + "Global state variable to indicate that an the this package is performing +actions that may undesirably trigger the file watcher.") + +(defun org-pandoc-import-transient--convert-file-name (file) + (if org-pandoc-import-transient--currently-processing + file + (unless (assoc file org-pandoc-import-transient--files) + (let* ((temp-dir (make-temp-file "org-transients/" t)) ; org pandoc transient file(s) + (org-file (expand-file-name (concat (file-name-base file) + ".org+" + (file-name-extension file)) + temp-dir)) + (symlink-file (expand-file-name (file-name-nondirectory file) + temp-dir)) + (org-pandoc-import-transient--currently-processing t)) + + (push (cons file (list :target org-file)) org-pandoc-import-transient--files) + (push (cons symlink-file (list :symlink file)) org-pandoc-import-transient--files) + (push (cons org-file (list :initialised nil :source file :source-symlink symlink-file)) org-pandoc-import-transient--files) + + (write-region "" nil org-file) + (make-symbolic-link file symlink-file) + + (message "Created org-file stub for %s (%s)" file org-file))) + + (if-let ((org-file + (plist-get (cdr (assoc file org-pandoc-import-transient--files)) :target))) + org-file file))) + +(defun org-pandoc-import-transient--maybe-converted-org-file-handler (operation &rest args) + (let ((inhibit-file-name-handlers + (cons 'org-pandoc-import-transient--maybe-converted-org-file-handler + (and (eq inhibit-file-name-operation operation) + inhibit-file-name-handlers))) + (inhibit-file-name-operation operation)) + + (if (and org-pandoc-import-transient-mode (not org-pandoc-import-transient--currently-processing)) + (cond + ((eq operation 'insert-file-contents) + (when-let* ((org-file (car args)) + (file-info (cdr (assoc org-file org-pandoc-import-transient--files))) + (source-file (plist-get file-info :source)) + (start-time (time-to-seconds (current-time))) + (org-pandoc-import-transient--currently-processing t)) + (unless (plist-get file-info :initialised) + (delete-file org-file) ; to avoid the overwrite prompt + (message "Initialising...") + (org-pandoc-import-to-org nil source-file org-file t) + (plist-put file-info :initialised t) + (setq-local kill-buffer-hook (append kill-buffer-hook '(org-pandoc-import-transient--killed))) + (message "Created org file from %s in %2fs." source-file (- (time-to-seconds (current-time)) start-time)))) + (apply operation args)) + ((eq operation 'write-region) + (let ((org-pandoc-import-transient--currently-processing t) + (org-export-with-broken-links t) + (org-export-with-toc nil)) + (apply operation args) + (when-let* ((file (nth 2 args)) + (source-file (plist-get (cdr (assoc file org-pandoc-import-transient--files)) :source)) + (exporter (cdr (assoc (file-name-extension source-file) org-pandoc-import-transient-associations))) + (start-time (time-to-seconds (current-time)))) + (if (functionp exporter) + (funcall exporter) + (org-export-to-file (intern exporter) source-file org-import-transient-async-export)) + (message "Updated %s in %2fs." source-file (- (time-to-seconds (current-time)) start-time))))) + (t (apply operation args))) + (apply operation args)))) + +(defun org-pandoc-import-transient--killed () + "When this buffer is closed, we assume that the source file is liable to be modified. +Thus, if we re-open the file with `org-pandoc-import-transient-mode' enabled, +we want to re-create the associated org file." + (plist-put (cdr (assoc (buffer-file-name) org-pandoc-import-transient--files)) :initialised nil)) + +(org-pandoc-import-transient--register-file-handlers) +(make-directory (expand-file-name "org-transients" temporary-file-directory) t) + +(provide 'org-pandoc-import-transient) diff --git a/org-pandoc-import.el b/org-pandoc-import.el new file mode 100644 index 0000000..01fcbb9 --- /dev/null +++ b/org-pandoc-import.el @@ -0,0 +1,321 @@ +;;; org-pandoc-import.el -*- lexical-binding: t; -*- + +;; Copyright 2020 tecosaur +;; +;; This file is part of org-pandoc-import. +;; +;; org-pandoc-import 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. +;; +;; org-pandoc-import 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 org-pandoc-import. If not, see . +;; +;; SPDX-License-Identifier: GPL-3.0-or-later + +(defgroup org-pandoc-import nil + "Provides methods to convert other markup files to Org." + :prefix 'org-pandoc-import) + +(defcustom org-pandoc-import-executable "pandoc" + "Location of the pandoc binary." + :type 'string + :group 'org-pandoc-import) + +(defcustom org-pandoc-import-buffer-name "*org-pandoc-import*" + "Name of the buffer to be created for the results of pandoc's conversion. +If a function, it is called to provide a string with the input file name +as the argument." + :type '(choice string function) + :group 'org-pandoc-import) + +(defcustom org-pandoc-import-setup-defaults t + "If non-nil, set up a number of default import backends." + :type 'boolean + :group 'org-pandoc-import) + +(defcustom org-pandoc-import-setup-folder + (file-name-directory + (eval-when-compile + (or (bound-and-true-p byte-compile-current-file) + load-file-name))) + "The folder from which will be used (by default) as the parent +for `org-pandoc-import-filters-folder' and `org-pandoc-import-preprocessor-folder'." + :type 'string + :group 'org-pandoc-import) + +(defcustom org-pandoc-import-filters-folder + (expand-file-name + "filters" org-pandoc-import-setup-folder) + "Location of Lua filters for use with pandoc. If FITERS/backend.lua exists, +it will automatically be used when backend is registered." + :type 'string + :group 'org-pandoc-import) + +(defcustom org-pandoc-import-preprocessor-folder + (expand-file-name + "preprocessors" org-pandoc-import-setup-folder) + "A file to but pre-processors in. When a new backend is defined, +if PREPROCESSORS/backend.el exists it will be loaded, and if +org-pandoc-import-(backend)-preprocessor exists, it will be called +with the input file as the argument, and the result used as the new input file." + :type 'string + :group 'org-pandoc-import) + +(defcustom org-pandoc-import-global-args nil + "List of arguments to apply to all backends. Accepts three types of atoms: +- strings, which are passed as-is to `call-process' +- plist keywords, which have the : replaced with single dash if the word is one charachter, else two dashes +- functions, which are evaluated and have the result passed as one of the arguments" + :type 'list + :group 'org-pandoc-import) + +(defcustom org-pandoc-import-global-filters + (directory-files org-pandoc-import-filters-folder nil "^_") + "List of filters to apply to all backends. Either the name of a file contained in +`org-pandoc-import-filters-folder', or a absolute path to a filter. + +Filters ending in '.lua' will be called with '--lua-filter', and all other filters with '--filter'. + +By default, all files starting with '_' in `org-pandoc-import-filters-folder' are used." + :type 'list + :group 'org-pandoc-import) + +(defvar org-pandoc-import-backends nil + "List of registerd org-pandoc-import backends.") + +;;;###autoload +(defmacro org-pandoc-import-backend (name &optional recognised-extensions pandoc-type filters pandoc-args) + "Create an export backend named NAME which is applied by default on RECOGNISED-EXTENSIONS. +This calls pandoc, specifying the input format to be PANDOC-TYPE. PANDOC-ARGS is a list of args passed to +the pandoc command in the same manner as `org-pandoc-import-global-args'. +Filters can be either absolute paths to pandoc filters, or names of files within `org-pandoc-import-filters-folder'. + +RECOGNISED-EXTENSIONS defaults to '(\"NAME\"), and PANDOC-TYPE to \"NAME\"." + (let* ((s-name (symbol-name name)) + (recognised-extensions (or recognised-extensions `'(,s-name))) + (pandoc-type (or pandoc-type s-name)) + (format-args (intern (format "org-pandoc-import-%s-args" s-name))) + (format-extensions (intern (format "org-pandoc-import-%s-extensions" s-name))) + (format-filters (intern (format "org-pandoc-import-%s-filters" s-name))) + (preprocessor (let ((preprocessor-file + (expand-file-name (concat s-name ".el") org-pandoc-import-preprocessor-folder)) + (preprocerror-func (intern (format "org-pandoc-import-%s-preprocessor" s-name)))) + (when (file-exists-p preprocessor-file) + (load-file preprocessor-file) + (fboundp preprocerror-func) + preprocerror-func))) + (common-args (list pandoc-type 'in-file format-extensions format-args format-filters + 'syncronous-p (when preprocessor `(function ,preprocessor)))) + (filters (or filters + (let ((filter (expand-file-name (concat s-name ".lua") + org-pandoc-import-filters-folder))) + (when (file-exists-p filter) (list filter)))))) + `(progn + (defvar ,format-args ,pandoc-args + ,(format "Arguments to be passed to pandoc when processing a %s file. +This is treated the same as `org-pandoc-import-global-args'" s-name)) + + (defvar ,format-extensions ,recognised-extensions + ,(format "File extensions to recognise as associated with %s." s-name)) + + (defvar ,format-filters ',filters + ,(format "Either an absolute path to, or the name of a filter within `org-pandoc-import-filters-folder' +to be applied when converting from %s. +This is treated the same as `org-pandoc-import-global-filters'" s-name)) + + (defun ,(intern (format "org-pandoc-import-%s-as-org" s-name)) (prompty &optional in-file syncronous-p) + ,(format "Parse the provided %s IN-FILE to org-mode and open in a new buffer. +Recognises files with extensions which are a member of `org-pandoc-import-%s-extensions'. +Calls pandoc with arguments listed in `org-pandoc-import-%s-args', and filters `org-pandoc-import-%s-filters'." s-name s-name s-name s-name) + (interactive "P") + (org-pandoc-import-convert prompty nil ,@common-args)) + + (defun ,(intern (format "org-pandoc-import-%s-to-org" s-name)) (prompty &optional in-file out-file syncronous-p) + ,(format "Parse the provided %s IN-FILE to org-mode and save to OUT-FILE - defulting to (file-name-base IN-FILE).org. +Recognises files with extensions which are a member of `org-pandoc-import-%s-extensions'. +Calls pandoc with arguments listed in `org-pandoc-import-%s-args', and filters `org-pandoc-import-%s-filters'." s-name s-name s-name s-name) + (interactive "P") + (org-pandoc-import-convert prompty (or out-file t) ,@common-args)) + + (add-to-list 'org-pandoc-import-backends ',name)))) + +(defun org-pandoc-import-convert (prompty out-file pandoc-type &optional in-file expected-extensions args filters syncronous-p preprocessor) + "Determine the relevant paramaters to convert IN-FILE of type PANDOC-TYPE to either OUT-FILE, or a buffer (when OUT-FILE is nil). +If PROMPTY is non-nill, then the value of IN-FILE and (if applicable) OUT-FILE will be always prompted for. +A prompt for IN-FILE is also triggered when IN-FILE is nil, or its extension is not a member of EXPECTED-EXTENSIONS. +A prompt for OUT-FILE is triggered when OUT-FILE is t, or the name of a pre-existing file. +Pandoc is then called with arguments from the list ARGS - as described in `org-pandoc-import-global-args', +and filters named in the list FILTERS - which can be either absolute paths to pandoc filters, or names of files within `org-pandoc-import-filters-folder'. + +If preprocessor is given, and a function, it is run with the value of IN-FILE. The value returned is used as the new IN-FILE." + + (let* ((in-file (or in-file + (if (and (not prompty) + (not (null (buffer-file-name))) + (if expected-extensions + (member (file-name-extension (buffer-file-name)) + expected-extensions)) + t) + (buffer-file-name) + (read-file-name "File to convert: " nil nil t)))) + (in-file-processed (if (and preprocessor (functionp preprocessor)) + (funcall preprocessor in-file) + in-file)) + (in-file-org (concat (file-name-sans-extension in-file) ".org")) + (out-file (if (eq t out-file) + (if prompty + (read-file-name "File to write: " + (file-name-directory in-file) + nil nil + (concat (file-name-base in-file) ".org")) + in-file-org) + out-file)) + (filter-args nil)) + + (if (and out-file (file-exists-p out-file)) + (unless (yes-or-no-p (format "Overwrite file %s? " + (file-relative-name + out-file + (file-name-directory in-file)))) + (setq out-file + (read-file-name "File to write: " + (file-name-directory in-file))))) + + (dolist (filter (append filters org-pandoc-import-global-filters)) + (setq filter-args + (append filter-args + (list (pcase (file-name-extension filter) + ("lua" "--lua-filter") + (_ "--filter")) + (if (= ?/ (aref filter 0)) filter + (expand-file-name filter org-pandoc-import-filters-folder)))))) + + (org-pandoc-import-run-convert + (org-pandoc-import-generate-convert-arguments + in-file-processed pandoc-type out-file (append args filter-args)) + in-file-processed out-file syncronous-p))) + + +(defun org-pandoc-import-run-convert (arguments in-file &optional out-file syncronous-p) + "Call pandoc on IN-FILE with ARGUMENTS, creating OUT-FILE if given. +`call-process' is used instead of `start-process' if SYNCRONOUS-P is non-nil." + (let* ((pandoc-buffer (generate-new-buffer + (if (functionp org-pandoc-import-buffer-name) + (funcall org-pandoc-import-buffer-name in-file) + org-pandoc-import-buffer-name))) + (process + (if syncronous-p + (apply #'call-process + org-pandoc-import-executable + nil + pandoc-buffer + nil + arguments) + (apply #'start-process + "org-pandoc-import" + pandoc-buffer + org-pandoc-import-executable + arguments)))) + (unless syncronous-p + (set-process-sentinel process (org-pandoc-import-process-sentinel pandoc-buffer out-file (time-to-seconds (current-time))))))) + +(defun org-pandoc-import-process-sentinel (process-buffer &optional out-file start-time-seconds) + "Creats a lambda sentinel for an pandoc process." + (lambda (process _signal) + (pcase (process-status process) + (exit (if out-file + (progn (find-file out-file) + (kill-buffer process-buffer)) + (switch-to-buffer process-buffer)) + (when start-time-seconds + (message "Converted docunent in %3fs" (- (time-to-seconds (current-time)) start-time-seconds))) + (org-mode)) + ((or stop signal failed) + (user-error (format "The pandoc process to create %s has exited unexpectedly." out-file)) + (switch-to-buffer process-buffer))))) + +(defun org-pandoc-import-generate-convert-arguments (in-file target-format &optional out-file arguments-list) + "Format the pandoc command to convert IN-FILE of pandoc type TARGET-FORMAT to the org file OUT-FILE (if given), +with arguments given by ARGUMENTS-LIST." + (let (arguments) + (dolist (element (reverse (append arguments-list org-pandoc-import-global-args))) + (push + (cond + ((stringp element) element) + ((keywordp element) (let ((keyword (substring (symbol-name element) 1))) + (pp keyword) + (concat (if (= 1 (length keyword)) "-" "--") + keyword))) + ((functionp element) (funcall element in-file target-format))) + arguments)) + (append (list "-f" target-format + "-t" "org") + (when out-file + (list "-o" out-file)) + arguments + (list in-file)))) + + +;;;###autoload +(defun org-pandoc-import-as-org (prompty &optional in-file syncronous-p) + "Parse the provided file to org-mode, and open in a new buffer. +With PROMPTY (given by the universal argument), always prompt for the IN-FILE to act on. + +This only works so long as these is backend registered in `org-pandoc-import-backends' +associated with the extension of the selected file. See 'org-pandoc-import-{backend}-as-org' +for more information on a particular backend." + (interactive "P") + (if-let ((backend (org-pandoc-import-find-associated-backend (or in-file (buffer-file-name))))) + (funcall (intern (format "org-pandoc-import-%s-as-org" (symbol-name backend))) + prompty in-file syncronous-p) + (funcall org-pandoc-import-as-org prompty (read-file-name "File to convert: ") syncronous-p))) + +;;;###autoload +(defun org-pandoc-import-to-org (prompty &optional in-file out-file syncronous-p) + "Parse the provided file to an org-mode file, and open. +With PROMPTY (given by the universal argument), always prompt for the IN-FILE to act on, +and the where to save the new Org file. + +This only works so long as these is backend registered in `org-pandoc-import-backends' +associated with the extension of the selected file. See 'org-pandoc-import-{backend}-as-org' +for more information on a particular backend." + (interactive "P") + (if-let ((backend (org-pandoc-import-find-associated-backend (or in-file (buffer-file-name))))) + (funcall (intern (format "org-pandoc-import-%s-to-org" (symbol-name backend))) + prompty in-file out-file syncronous-p)) + (funcall org-pandoc-import-to-org prompty (read-file-name "File to convert: ") syncronous-p)) + + +(defun org-pandoc-import-find-associated-backend (file) + "Find the backend symbol from `org-pandoc-import-backends' that is last associated with +the extension of FILE, or nil if no such association could be found." + (let ((ext (file-name-extension file)) + the-backend) + (dolist (backend org-pandoc-import-backends) + (when (member ext (symbol-value + (intern + (format "org-pandoc-import-%s-extensions" + (symbol-name backend))))) + (setq the-backend backend))) + the-backend)) + +(dont-compile + (when org-pandoc-import-setup-defaults + (org-pandoc-import-backend markdown '("md" "markdown")) + (org-pandoc-import-backend latex '("tex" "latex")) + (org-pandoc-import-backend rst) + (org-pandoc-import-backend odt) + (org-pandoc-import-backend docx) + (org-pandoc-import-backend rmarkdown '("rmd" "Rmd") "markdown") + (org-pandoc-import-backend ipynb) + (org-pandoc-import-backend csv) + (org-pandoc-import-backend tsv '("tsv") "csv"))) + +(provide 'org-pandoc-import) diff --git a/org-pandoc-import.svg b/org-pandoc-import.svg new file mode 100644 index 0000000..d2fff9f --- /dev/null +++ b/org-pandoc-import.svg @@ -0,0 +1,853 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/preprocessors/rmarkdown.el b/preprocessors/rmarkdown.el new file mode 100644 index 0000000..d3c7e08 --- /dev/null +++ b/preprocessors/rmarkdown.el @@ -0,0 +1,7 @@ +;;; org-pandoc-import/preprocessors/rmarkdown.el -*- lexical-binding: t; -*- + +(defun org-pandoc-import-rmarkdown-preprocessor (in-file) + (let ((processed-file (make-temp-file "opif" nil ".Rmd"))) + (call-process "sed" nil (list :file processed-file) nil "s/^```{/```\\n{/" in-file) + (message processed-file) + processed-file)) diff --git a/preprocessors/tsv.el b/preprocessors/tsv.el new file mode 100644 index 0000000..098e9da --- /dev/null +++ b/preprocessors/tsv.el @@ -0,0 +1,7 @@ +;;; org-pandoc-import/preprocessors/tsv.el -*- lexical-binding: t; -*- + +(defun org-pandoc-import-tsv-preprocessor (in-file) + (let ((processed-file (make-temp-file "opif" nil ".csv"))) + (call-process "sed" nil (list :file processed-file) nil "-E" "s/\\t+/,/g" in-file) + (message processed-file) + processed-file)) diff --git a/screenshots/csv.png b/screenshots/csv.png new file mode 100644 index 0000000..d177f09 Binary files /dev/null and b/screenshots/csv.png differ diff --git a/screenshots/markdown.png b/screenshots/markdown.png new file mode 100644 index 0000000..e6f18b4 Binary files /dev/null and b/screenshots/markdown.png differ diff --git a/screenshots/odt.png b/screenshots/odt.png new file mode 100644 index 0000000..d5b759c Binary files /dev/null and b/screenshots/odt.png differ