diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,6 @@ +# Revision history for tex-builder + + +0.1.0.1 +--- +* Initial release. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -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/Main.hs b/Main.hs new file mode 100644 --- /dev/null +++ b/Main.hs @@ -0,0 +1,125 @@ +module Main where + +import TexBuilder.TexBuilder +import TexBuilder.FileFilters +import TexBuilder.ChooseEngine + +import Data.Semigroup hiding (option) +import Data.List (intercalate) +import Numeric.Natural + +import Options.Applicative +import Options.Applicative.Builder + + +main :: IO () +main = execParser parser >>= id + where + parser = info (helper <*> opts) + (fullDesc + <> header hdr + <> progDesc description ) + + opts = pure texBuilder + <*> texOpt + <*> optional pdfOpt + <*> fileTypesOpt + <*> depthOpt + <*> (statefulFlag <|> persistFlag <|> pure Pure) + -- <*> watchOpt + <*> engineOption + <*> nolatexmkFlag + <*> numCompOpt + <*> extraArgs + +pdfOpt :: Parser FilePath +pdfOpt = option str + ( short 'p' <> long "pdf" <> metavar "PDFFILE" + <> help "The name of the pdf file to write to \ + \ (defaults to TEXFILE with file ending adjusted)." ) + +texOpt :: Parser FilePath +texOpt = option str + ( short 't' <> long "tex" <> metavar "TEXFILE" + <> help "The main tex file to compile." ) + +fileTypesOpt :: Parser Exts +fileTypesOpt = option (maybeReader readExts) + ( short 'f' <> long "file-types" <> value (Exts ["tex","bib"]) + <> showDefaultWith showExts <> metavar "EXTENSIONS" + <> help "Watch for changes of all files in the directory,\ + \ with these file endings." ) + +depthOpt :: Parser Natural +depthOpt = option auto + ( short 'd' <> long "depth" <> value 3 + <> showDefault <> metavar "DEPTH" + <> help "The depth to descend into directories." ) + +statefulFlag :: Parser StatePolicy +statefulFlag = flag' Stateful + ( long "stateful" + <> help "Run in stateful mode, reusing results from\ + \ previous compile runs. This improves efficiency\ + \ but may lead to artifacts in some situations.") + + +persistFlag :: Parser StatePolicy +persistFlag = flag' Persistent + ( long "persistent" + <> help "Run in persistent mode, using the main directory\ + \ for building. If the state gets messed up, YOU\ + \ will have to fix it.") + +-- | not yet ready +watchOpt :: Parser String +watchOpt = option str + ( short 'w' <> long "watch" + <> help "Watch for changes of these files ONLY." ) + +engineOption :: Parser UseEngine +engineOption = option (maybeReader readUseEngine) + ( short 'e' <> long "engine" <> metavar "ENGINE" + <> value UseLuaLaTex + <> showDefaultWith showUseEngine + <> help engineHelp ) + +noluaFlag :: Parser UseEngine +noluaFlag = flag UseLuaLaTex UsePdfLaTex + ( long "noluatex" + <> help "Do not user luaLaTex / use pdfLaTex instead." ) + +nolatexmkFlag :: Parser UseLatexMk +nolatexmkFlag = flag UseLatexMk UseNoLatexMk + ( long "nolatexmk" + <> help "Do not go through latexmk, use engine directly." ) + +numCompOpt :: Parser Natural +numCompOpt = option auto + ( short 'r' <> long "recompile" <> metavar "NRECOMP" <> value 5 + <> help "The maximum number of times we should attempt to \ + \recompile the document unil it becomes stable \ + \when using the latex engine directly." + <> showDefault ) + +extraArgs :: Parser [String] +extraArgs = many $ strArgument + ( metavar "EXTRA_ARGS" + <> help "Extra arguments to pass to the latex engine." ) + +hdr = "texbuilder: view your latex output while editing" + +engineHelp = "Use this latex engine, can be one of [" + <> intercalate "|" ( showUseEngine <$> [minBound..maxBound] ) + <> "]." + +description = + "This program allows you to view your document \ + \in your pdf viewer while editing it in your favorite editor. \ + \When you save your document, it will recompile it, \ + \overwrite the output pdf file and send a signal \ + \to your pdf reader to reload the file. \ + \This effectively allows for a \"continous preview\"-like \ + \experience." + + diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +# texbuilder +## What it is + +This program allows you to view your latex document in your pdf +reader while editing it in your favorite editor. When you save +your document, it will recompile it, overwrite the output pdf file +and send a signal to your pdf reader to reload the file. +This effectively allows for a "continous preview"-like experience. + +## Prerequisites and Dependencies + * linux (we use inotify) + * a recent cabal / ghc + * (currently only works with) mupdf + * working latex with lualatex, xelatex or pdflatex and ideally latexmk + +## How to build from git + +```sh +git clone https://gitlab.com/xaverdh/tex-builder +cd tex-builder +cabal sandbox init +cabal install --bindir . --ghc-option=-threaded +``` +Alternatively you can use the provided [build script][build-script]. +So assuming you have wget you cound do: + +```sh +wget -O - https://gitlab.com/xaverdh/tex-builder/raw/master/build | sh +``` + +## Usage + +Say you want to compile a tex file thesis.tex then standard usage would be: +```sh +texbuilder -t thesis.tex +``` +By default texbuilder will use a fresh environment for every compile run. This may +sound wasteful, but is quite feasible with average sized tex files on modern harware. +And it does avoid problems with messed up state, when something goes wrong. + +Still if you do have problems with performance, use the ` --stateful ` flag. + +Finally if you really really need all those intermediate representation files +in your directory, use ` --persistent `. + +## Legal + +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 +any later version. + +See LICENSE for more details. + + +[build-script]: https://gitlab.com/xaverdh/tex-builder/blob/master/build + diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/TexBuilder/ChooseEngine.hs b/TexBuilder/ChooseEngine.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/ChooseEngine.hs @@ -0,0 +1,107 @@ +{-# LANGUAGE LambdaCase #-} +module TexBuilder.ChooseEngine + ( chooseEngine + , readUseEngine + , showUseEngine + , UseEngine(..) + , UseLatexMk(..) ) +where + +import TexBuilder.Utils.File +import TexBuilder.Engine + +import qualified Text.PrettyPrint.ANSI.Leijen as PP +import Control.Applicative +import Control.Monad +import Control.Monad.Extra +import System.Exit +import Data.Monoid + + + +data UseEngine = + UseLuaLaTex + | UsePdfLaTex + | UseXeLaTex + deriving (Enum,Bounded) + +readUseEngine :: String -> Maybe UseEngine +readUseEngine s + | s == "lualatex" = Just UseLuaLaTex + | s == "xelatex" = Just UseXeLaTex + | s == "pdflatex" = Just UsePdfLaTex + | otherwise = Nothing + +showUseEngine :: UseEngine -> String +showUseEngine = enginePath + +data UseLatexMk = UseLatexMk | UseNoLatexMk + + +chooseEngine :: UseEngine -> UseLatexMk -> IO Engine +chooseEngine useEngine useLatexmk = do + engine <- chooseLatexEngine useEngine + texmk <- chooseLatexMk useLatexmk + pure $ case (engine,texmk) of + (UseLuaLaTex,UseLatexMk) -> LuaLaTexMk + (UseLuaLaTex,UseNoLatexMk) -> LuaLaTex + (UsePdfLaTex,UseLatexMk) -> PdfLaTexMk + (UsePdfLaTex,UseNoLatexMk) -> PdfLaTex + (UseXeLaTex,UseLatexMk) -> XeLaTexMk + (UseXeLaTex,UseNoLatexMk) -> XeLaTex + + +chooseLatexEngine :: UseEngine -> IO UseEngine +chooseLatexEngine = fallback . \case + UseLuaLaTex -> UseLuaLaTex : [UsePdfLaTex,UseXeLaTex] + UsePdfLaTex -> UsePdfLaTex : [UseXeLaTex,UseLuaLaTex] + UseXeLaTex -> UseXeLaTex : [UsePdfLaTex,UseLuaLaTex] + where + numEngines = fromEnum ( maxBound :: UseEngine ) + +chooseLatexMk :: UseLatexMk -> IO UseLatexMk +chooseLatexMk = \case + UseLatexMk -> useMk + UseNoLatexMk -> pure UseNoLatexMk + +haveMk :: IO Bool +haveMk = haveExe "latexmk" + +useMk :: IO UseLatexMk +useMk = ifM haveMk (pure UseLatexMk) $ do + warn "No latexmk in PATH, using engine directly." + pure UseNoLatexMk + + +enginePath :: UseEngine -> FilePath +enginePath = \case + UseLuaLaTex -> "lualatex" + UsePdfLaTex -> "pdflatex" + UseXeLaTex -> "xelatex" + +haveEngine :: UseEngine -> IO Bool +haveEngine = haveExe . enginePath + +fallback :: [UseEngine] -> IO UseEngine +fallback = \case + [] -> errorNoEngine + useEng:useEngines -> + ifM (haveEngine useEng) (pure useEng) $ do + warn (enginePath useEng <> " not in PATH.") + warnFallback useEngines + fallback useEngines + where + warnFallback [] = pure () + warnFallback (useEng:_) = + warn ("Falling back to " <> enginePath useEng <> ".") + +warn :: String -> IO () +warn s = PP.putDoc . PP.yellow + $ PP.string s <> PP.hardline + +errorNoEngine = do + PP.putDoc . PP.red + $ PP.string "No latex engine found!" + exitWith $ ExitFailure 2 + + diff --git a/TexBuilder/CompileThread.hs b/TexBuilder/CompileThread.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/CompileThread.hs @@ -0,0 +1,54 @@ +module TexBuilder.CompileThread + ( compileThread ) +where + +import TexBuilder.Utils.BinSem +import TexBuilder.Utils.Hashing +import TexBuilder.Engine + +import qualified Text.PrettyPrint.ANSI.Leijen as PP +import qualified Data.Map as M + +import Control.Monad +import Control.Monad.Extra +import Control.Monad.State +import Control.Concurrent.MVar + + + +data CompileLoopState = CompileLoopState + { oldHashes :: M.Map FilePath (Digest MD5) + , watchMVar :: MVar FilePath } + + +compileThread :: IO PP.Doc -- ^ The code compilation action + -> BinSem + -- ^ Signaling semaphore to communicate when the + -- pdf view should be updated. + -> MVar FilePath + -- ^ Communication MVar for signaling file changes + -> M.Map FilePath (Digest MD5) + -- ^ Initial hashes + -> IO () +compileThread run viewSem wMVar hashes = + evalStateT compileLoop $ CompileLoopState hashes wMVar + where + compileLoop = do + path <- lift . takeMVar =<< gets watchMVar + -- ^ Wait for watcher thread to signal potential changes + withHash path $ \newHash -> do + table <- gets oldHashes + case M.lookup path table of -- ^ lookup old hash + Nothing -> go + Just oldHash -> when (oldHash /= newHash) go + -- ^ Compile when file was changed + modify $ \st -> + st { oldHashes = M.insert path newHash table } + -- ^ Write new hash value + compileLoop + + go = lift $ do + run >>= PP.putDoc + signal viewSem + + diff --git a/TexBuilder/Engine.hs b/TexBuilder/Engine.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/Engine.hs @@ -0,0 +1,220 @@ +{-# LANGUAGE LambdaCase, OverloadedStrings #-} +module TexBuilder.Engine + ( Engine(..) + , compile + , luaLaTex + , pdfLaTex + , recompile + , luaLaTexMk + , pdfLaTexMk ) +where + +import TexBuilder.Utils.Hashing +import TexBuilder.Utils.File + +-- import Data.Semigroup +import Data.Monoid + +import Numeric.Natural +import Text.PrettyPrint.ANSI.Leijen ((<+>)) +import qualified Text.PrettyPrint.ANSI.Leijen as PP + +import Control.Monad.State + +import System.Directory +import System.FilePath +import System.Process +import System.Exit +import System.Environment (setEnv) +import System.Posix.Time (epochTime) + +data Engine = + LuaLaTexMk + | LuaLaTex + | PdfLaTexMk + | PdfLaTex + | XeLaTexMk + | XeLaTex + +runEngine :: Natural -> Engine -> EngineImpl +runEngine nrecomp = \case + LuaLaTexMk -> luaLaTexMk + LuaLaTex -> recompile nrecomp luaLaTex + PdfLaTexMk -> pdfLaTexMk + PdfLaTex -> recompile nrecomp pdfLaTex + XeLaTexMk -> xeLaTex + XeLaTex -> recompile nrecomp xeLaTex + +type EngineImpl = + FilePath -> FilePath -> [String] -> IO (Either String FilePath) + +data RecompileState = + StInitial Natural + | StSucc Natural FilePath (Digest MD5) + + +-- | Recompile the code until the output stabilizes +-- or maxNum compile runs is reached. +-- Care must be taken to make the latex output reproductible. +-- Otherwise the output will never stablilize. +recompile :: Natural -> EngineImpl -> EngineImpl +recompile maxNum engine outDir texfile extraArgs = do + time <- show <$> epochTime + evalStateT (recompileSt (run time)) (StInitial maxNum) + where + run time = do + setEnv "SOURCE_DATE_EPOCH" time + -- ^ For reproductible output + engine outDir texfile extraArgs + + +recompileSt :: IO (Either String FilePath) + -> StateT RecompileState IO (Either String FilePath) +recompileSt run = get >>= \case + StInitial maxNum -> go $ succ maxNum + StSucc i path oldHash -> + if i <= 0 then done path + else go $ \path hash -> + if hash == oldHash then done path + else succ i path hash + where + go k = lift run >>= \case + Left err -> failed err + Right path -> withHash path $ k path + + succ i path hash = do + put $ StSucc (i-1) path hash + recompileSt run + + done = pure . Right + failed = pure . Left + + +luaLaTex :: EngineImpl +luaLaTex outDir texfile extraArgs = do + (exCode,out,err) <- readProcessWithExitCode + "/usr/bin/lualatex" args "" + pure $ case exCode of + ExitSuccess -> Right $ outDir jobname <.> "pdf" + ExitFailure _ -> Left out + where + args = + [ "--interaction=scrollmode" + , "--output-directory=" <> outDir + , "--jobname=" <> jobname + , "--output-format=pdf" + , "--file-line-error" ] + ++ extraArgs ++ [ texfile ] + jobname = "texbuilder-job" + +pdfLaTex :: EngineImpl +pdfLaTex outDir texfile extraArgs = do + (exCode,out,err) <- readProcessWithExitCode + "/usr/bin/pdflatex" args "" + pure $ case exCode of + ExitSuccess -> Right $ outDir jobname <.> "pdf" + ExitFailure _ -> Left out + where + args = + [ "--interaction=scrollmode" + , "--output-directory=" <> outDir + , "--jobname=" <> jobname + , "--output-format=pdf" + , "--file-line-error" ] + ++ extraArgs ++ [ texfile ] + jobname = "texbuilder-job" + +xeLaTex :: EngineImpl +xeLaTex outDir texfile extraArgs = do + (exCode,out,err) <- readProcessWithExitCode + "/usr/bin/xelatex" args "" + pure $ case exCode of + ExitSuccess -> Right $ outDir jobname <.> "pdf" + ExitFailure _ -> Left out + where + args = + [ "--interaction=scrollmode" + , "--output-directory=" <> outDir + , "--jobname=" <> jobname + , "--output-format=pdf" + , "--file-line-error" ] + ++ extraArgs ++ [ texfile ] + jobname = "texbuilder-job" + + +xeLaTexMk :: EngineImpl +xeLaTexMk outDir texfile extraArgs = do + (exCode,out,err) <- readProcessWithExitCode + "/usr/bin/latexmk" args "" + pure $ case exCode of + ExitSuccess -> Right $ outDir jobname <.> "pdf" + ExitFailure _ -> Left out + where + args = + [ "-xelatex" + , "-output-directory=" <> outDir + , "-jobname=" <> jobname ] + ++ extraArgs ++ [ texfile ] + jobname = "texbuilder-job" + + + +luaLaTexMk :: EngineImpl +luaLaTexMk outDir texfile extraArgs = do + (exCode,out,err) <- readProcessWithExitCode + "/usr/bin/latexmk" args "" + pure $ case exCode of + ExitSuccess -> Right $ outDir jobname <.> "pdf" + ExitFailure _ -> Left out + where + args = + [ "-lualatex" + , "-output-directory=" <> outDir + , "-jobname=" <> jobname ] + ++ extraArgs ++ [ texfile ] + jobname = "texbuilder-job" + +pdfLaTexMk :: EngineImpl +pdfLaTexMk outDir texfile extraArgs = do + (exCode,out,err) <- readProcessWithExitCode + "/usr/bin/latexmk" args "" + pure $ case exCode of + ExitSuccess -> Right $ outDir jobname <.> "pdf" + ExitFailure _ -> Left out + where + args = + [ "-pdf" + , "-output-directory=" <> outDir + , "-jobname=" <> jobname ] + ++ extraArgs ++ [ texfile ] + jobname = "texbuilder-job" + +-- | Compile the tex code and (if successful) +-- write the output to given path. Returns human readable +-- information about the build success / failure. +compile :: Engine + -> Natural + -> FilePath + -> FilePath + -> [String] + -> FilePath + -> IO PP.Doc +compile engine nrecomp texfile pdffile extraArgs dir = do + initT <- epochTime + runEngine nrecomp engine dir texfile extraArgs >>= \case + Left err -> pure $ PP.red $ PP.text err + Right outFile -> do + finalT <- epochTime + copyFile outFile pdffile + pure $ PP.green $ + "Successful build from" + <+> PP.text dir <> "," + <+> "build time was" + <+> (PP.text . show $ finalT - initT) + <+> "s" <> PP.hardline + + + + + + diff --git a/TexBuilder/FileFilters.hs b/TexBuilder/FileFilters.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/FileFilters.hs @@ -0,0 +1,34 @@ +module TexBuilder.FileFilters + ( Exts(..) + , showExts + , readExts + , extFilter ) +where + +import qualified Data.List as L +import Control.Monad.State + +import System.FilePath + +data Exts = Exts [String] + +showExts :: Exts -> String +showExts (Exts exts) = + L.intercalate "," exts + +readExts :: String -> Maybe Exts +readExts [] = Nothing +readExts s = Just $ Exts parts + where + parts = evalState splitter (s,[]) + + splitter = do + (s,r) <- get + case L.break (==',') s of + (a,_:b) -> put (b,a:r) *> splitter + (a,[]) -> pure (a:r) + +extFilter :: Exts -> FilePath -> Bool +extFilter (Exts exts) path = + takeExtension path `elem` map ('.':) exts + diff --git a/TexBuilder/TexBuilder.hs b/TexBuilder/TexBuilder.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/TexBuilder.hs @@ -0,0 +1,134 @@ +module TexBuilder.TexBuilder + ( texBuilder + , StatePolicy(..) + , UseEngine(..) + , UseLatexMk(..) ) +where + +import TexBuilder.Utils.File +import TexBuilder.Utils.Inotify +import TexBuilder.Utils.BinSem +import TexBuilder.Utils.Hashing +import TexBuilder.Engine +import TexBuilder.ChooseEngine +import TexBuilder.Watches +import TexBuilder.CompileThread +import TexBuilder.ViewThread +import TexBuilder.FileFilters + +import qualified Text.PrettyPrint.ANSI.Leijen as PP +import Control.Applicative +import Control.Monad +import Control.Monad.Extra +-- import Data.Semigroup +import Data.Monoid +import Data.Maybe +import qualified Data.Map as M +import Numeric.Natural + +import Options.Applicative +import Options.Applicative.Builder +import System.Directory +import System.FilePath +import System.IO.Temp +import Control.Concurrent +import Control.Concurrent.MVar + + +data StatePolicy = Pure | Stateful | Persistent + +texBuilder :: FilePath + -> Maybe FilePath + -> Exts + -> Natural + -> StatePolicy + -> UseEngine + -> UseLatexMk + -> Natural + -> [String] + -> IO () +texBuilder + texfile mbPdfFile exts depth statePolicy + useEngine useLatexmk nrecomp extraArgs + = do + engine <- chooseEngine useEngine useLatexmk + let runRaw = compile engine nrecomp texfile pdffile extraArgs + withModRunAction statePolicy texDir listSrcFiles runRaw + $ \run -> do + assertFileEx texfile + -- ^ Assert that the tex file exists + initialCompile pdffile run + -- ^ Do an initial compile run if appropriate + sem <- newBinSem + -- ^ Signaling semaphore connecting the threads + withInitialHashes listSrcFiles $ \hashes -> do + watchMVar <- newEmptyMVar + wtid <- forkIO $ + setupWatches depth texDir fileFilter watchMVar + ctid <- forkIO $ + compileThread run sem watchMVar hashes + -- ^ The thread which compiles the tex code + onFileEx pdffile ( mupdfView pdffile sem ) + -- ^ Enter the main thread which updates the pdf view + putStrLn "mupdf exited, terminating" + killThread wtid + killThread ctid + where + fileFilter = extFilter exts + + texDir = takeDirectory texfile + + listSrcFiles = listSourceFiles depth texDir fileFilter + + pdffile = fromMaybe (texfile -<.> "pdf") mbPdfFile + + +initialCompile :: FilePath -> IO PP.Doc -> IO () +initialCompile pdffile run = + unlessM (doesFileExist pdffile) $ do + putStrLn "No ouput file detected, compiling." + run >>= PP.putDoc + +listSourceFiles :: Natural + -> FilePath + -> ( FilePath -> Bool ) + -> IO [FilePath] +listSourceFiles depth texDir fileFilter = + listSubdirs depth texDir + >>= searchFilesWith fileFilter + +withInitialHashes :: IO [FilePath] + -> ( M.Map FilePath (Digest MD5) -> IO b) + -> IO b +withInitialHashes listSrc k = do + files <- listSrc + withHashes files $ k . M.fromList . zip files + + +withDirSetup :: FilePath + -> FilePath + -> IO [FilePath] + -> ( FilePath -> IO a ) -> IO a +withDirSetup wdir texDir listSrc k = do + files <- listSrc + forM_ files $ copyRelative texDir wdir + k wdir + +withModRunAction :: StatePolicy + -> FilePath + -> IO [FilePath] + -> ( FilePath -> IO PP.Doc ) + -> ( IO PP.Doc -> IO a ) -> IO a +withModRunAction statePolicy texDir listSrc run k = + case statePolicy of + Pure -> k $ withTmp $ \tmpdir -> runIn tmpdir + -- ^ Create fresh temporary directory every time + Stateful-> withTmp $ \tmpdir -> k $ runIn tmpdir + -- ^ Run in stateful temporary directory + Persistent -> getCurrentDirectory >>= \wdir -> k $ runIn wdir + -- ^ Run in persistent working directory + where + withTmp = withSystemTempDirectory "texbuilder" + runIn wdir = withDirSetup wdir texDir listSrc run + + diff --git a/TexBuilder/Utils/BinSem.hs b/TexBuilder/Utils/BinSem.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/Utils/BinSem.hs @@ -0,0 +1,26 @@ +module TexBuilder.Utils.BinSem where + +import Control.Concurrent.MVar +import Control.Monad + + +type BinSem = MVar () + +newBinSem :: IO BinSem +newBinSem = newEmptyMVar + +wait :: BinSem -> IO () +wait = takeMVar + +signal :: BinSem -> IO () +signal = flip putMVar () + +trySignal :: BinSem -> IO Bool +trySignal = flip tryPutMVar () + +trySignal' :: BinSem -> IO () +trySignal' = void . trySignal + + + + diff --git a/TexBuilder/Utils/File.hs b/TexBuilder/Utils/File.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/Utils/File.hs @@ -0,0 +1,64 @@ +module TexBuilder.Utils.File where + +import Control.Monad +import Control.Monad.Extra + +import System.Directory +import System.FilePath +import System.Exit + +import Numeric.Natural +import Data.Semigroup +import Data.Maybe + + +listDirAbsolute :: FilePath -> IO [FilePath] +listDirAbsolute dir = do + dir' <- makeAbsolute dir + map (dir') <$> listDirectory dir' + + +listSubdirs :: Natural -> FilePath -> IO [FilePath] +listSubdirs = walkSubdirs (const pure) + + +walkSubdirs :: (Natural -> FilePath -> IO a) + -> Natural -> FilePath + -> IO [a] +walkSubdirs f 0 dir = fmap pure $ f 0 dir +walkSubdirs f depth dir = do + paths <- listDirAbsolute dir + dirs <- filterM doesDirectoryExist paths + results <- forM dirs $ walkSubdirs f (depth-1) + (:join results) <$> f depth dir + + +searchFilesWith :: (FilePath -> Bool) -> [FilePath] -> IO [FilePath] +searchFilesWith f dirs = do + paths <- join <$> forM dirs listDirAbsolute + pure $ filter f paths + + +-- | Copy file /file/ from dir1 to dir2, creating +-- directories as needed. The path of the resulting +-- copy relative to dir2 will be the same as the path +-- of the original file relative dir1 +copyRelative :: FilePath -> FilePath -> FilePath -> IO () +copyRelative dir1 dir2 file = do + dir1' <- makeAbsolute dir1 + let relFile = makeRelative dir1' file + let destFile = dir2 relFile + let destDir = takeDirectory destFile + createDirectoryIfMissing True destDir + copyFile file destFile + +assertFileEx :: FilePath -> IO () +assertFileEx file = + unlessM (doesFileExist file) $ do + putStrLn (file <> " does not exist.") + exitFailure + +haveExe :: String -> IO Bool +haveExe name = isJust <$> findExecutable name + + diff --git a/TexBuilder/Utils/Hashing.hs b/TexBuilder/Utils/Hashing.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/Utils/Hashing.hs @@ -0,0 +1,38 @@ +{-# LANGUAGE PackageImports #-} +module TexBuilder.Utils.Hashing + ( withHash + , withHashes + , module Crypto.Hash ) +where + +import Control.Monad +import Control.Monad.Trans +import Control.DeepSeq + +import "cryptonite" Crypto.Hash +import qualified Data.ByteString.Lazy as LB +-- import qualified Data.ByteString as B + + +withHash :: (MonadIO io,HashAlgorithm a) + => FilePath -> (Digest a -> io b) -> io b +withHash path k = do + hash <- liftIO (hashlazy <$> LB.readFile path) + deepseq hash $ k hash + -- ^ deepseq is neccessary to force reading to + -- actually happen here (we want to capture the + -- _current_ state of the file). + +withHashes :: + (MonadIO io,HashAlgorithm a,Traversable t,NFData (t (Digest a))) + => t FilePath -> (t (Digest a) -> io b) -> io b +withHashes paths k = do + hashes <- forM paths $ \path -> + liftIO (hashlazy <$> LB.readFile path) + deepseq hashes $ k hashes + -- ^ deepseq is neccessary to force reading to + -- actually happen here (we want to capture the + -- _current_ state of the file). + + + diff --git a/TexBuilder/Utils/Inotify.hs b/TexBuilder/Utils/Inotify.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/Utils/Inotify.hs @@ -0,0 +1,91 @@ +module TexBuilder.Utils.Inotify where + +import TexBuilder.Utils.BinSem + +import Control.Concurrent.MVar +import Control.Monad +import Control.Monad.Extra + +import System.INotify +import System.Directory +import System.FilePath + + +-- Be careful with this stuff. +-- Inotify is _inode_ based, but these functions want +-- to watch _paths_. So they reregister the watches +-- when necessary. Still it is probably best to look +-- at the implementation before using them. +-- Also this whole business is rather error prone.. + +-- ^ Simple version of /withEvent/ +onEvent :: [EventVariety] -> FilePath -> IO a -> IO () +onEvent variety file k = withEvent variety file (const k) + +-- ^ Execute action once an event involving the given +-- filepath happens. +-- This function blocks. +withEvent :: [EventVariety] + -> FilePath + -> (Event -> IO a) + -> IO () +withEvent variety file k = + withINotify $ \inotify -> do + sem <- newBinSem + wd <- addWatch inotify variety file + (k >=> const (trySignal' sem)) + wait sem + removeWatch wd + +-- ^ Simple version of /loopWithEvent/ +loopOnEvent :: [EventVariety] -> FilePath -> IO Bool -> IO () +loopOnEvent variety file k = loopWithEvent variety file (const k) + +-- ^ Execute action every time an Event involving the given +-- filepath happens untils the callback returns True. +-- This function blocks. +loopWithEvent :: [EventVariety] -- ^ Events to watch + -> FilePath -- ^ Filepath to watch + -> (Event -> IO Bool) + -- ^ Callback. If it returns True we stop looping + -> IO () +loopWithEvent variety file k = + withINotify $ \inotify -> do + doneMVar <- newEmptyMVar + loopWithEventImpl variety file k inotify doneMVar + + +loopWithEventImpl :: [EventVariety] + -> FilePath + -> (Event -> IO Bool) + -> INotify + -> MVar Bool + -> IO () +loopWithEventImpl variety file k inotify doneMVar = loop + where + loop = do + wd <- watch + done <- takeMVar doneMVar + removeWatch wd + unless done loop + watch = addWatch inotify variety file + (k >=> putMVar doneMVar) + + +waitForFile :: FilePath -> IO () +waitForFile file = + loopOnEvent [Create] dir (doesFileExist file) + where dir = takeDirectory file + + +onFileEx :: FilePath -> IO a -> IO a +onFileEx file action = + unlessM + (doesFileExist file) + (waitForFile file) + *> action + + + + + diff --git a/TexBuilder/ViewThread.hs b/TexBuilder/ViewThread.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/ViewThread.hs @@ -0,0 +1,43 @@ +module TexBuilder.ViewThread + ( mupdfView ) +where + +import TexBuilder.Utils.BinSem + +import Data.Functor +import Control.Monad +import Control.Concurrent +import System.Posix.Types +import System.Posix.Signals +import System.Process +import System.Process.Internals + + + +mupdfView :: FilePath -- ^ The path of the file to view + -> BinSem + -- ^ Signaling semaphore to communicate when the + -- pdf view should be updated. + -> IO () +mupdfView pdffile sem = do + ph <- spawnProcess "/usr/bin/mupdf" [pdffile] + Just pid <- getPid ph + tid <- forkIO $ signalThread pid sem + exCode <- waitForProcess ph + killThread tid + +signalThread :: ProcessID -> BinSem -> IO () +signalThread pid sem = do + wait sem + signalProcess sigHUP pid + signalThread pid sem + +getPid :: ProcessHandle -> IO (Maybe CPid) +getPid = flip withProcessHandle $ \ph_ -> + case ph_ of + OpenHandle x -> pure $ Just x + ClosedHandle _ -> pure Nothing + + + + diff --git a/TexBuilder/Watches.hs b/TexBuilder/Watches.hs new file mode 100644 --- /dev/null +++ b/TexBuilder/Watches.hs @@ -0,0 +1,61 @@ +{-# LANGUAGE LambdaCase #-} +module TexBuilder.Watches + ( setupWatches ) +where + + +import TexBuilder.Utils.File + +import Control.Monad +import Control.Monad.Extra +import Control.Concurrent.MVar +import System.INotify +import System.Directory +import System.FilePath + +import Numeric.Natural + +setupWatches :: Natural -- ^ Depth to descend into directories + -> FilePath -- ^ Path of the directory to watch + -> (FilePath -> Bool) -- ^ File filter + -> MVar FilePath + -> IO b +setupWatches depth texDir fileFilter watchMVar = + withINotify $ \inotify -> do + dirMVar <- newEmptyMVar + walkSubdirs (watch dirMVar inotify) depth texDir + loop dirMVar inotify + where + watch mvar inotify depth dir = + void $ addWatch inotify [Modify,Create,Delete] dir + ( watcherThread mvar depth dir watchMVar fileFilter ) + + loop dirMVar inotify = do + (dir,depth) <- takeMVar dirMVar + walkSubdirs (watch dirMVar inotify) depth texDir + loop dirMVar inotify + + + +watcherThread :: MVar (FilePath,Natural) + -- ^ Directory creation MVar + -> Natural -- ^ Depth + -> FilePath -- ^ Directory we are watching + -> MVar FilePath -- ^ Watch MVar + -> (FilePath -> Bool) -- ^ File filter + -> Event -- ^ Recieved event + -> IO () +watcherThread dirMVar depth dir watchMVar fileFilter = \case + Modified False mbPath -> + whenJust mbPath $ \path -> + when (fileFilter path) $ post path + Created False path -> + when (fileFilter path) $ post path + Created True path -> + when (depth > 0) $ putMVar dirMVar (dir path,depth) + Ignored -> pure () + _ -> pure () + where + post path = putMVar watchMVar (dir path) + + diff --git a/texbuilder.cabal b/texbuilder.cabal new file mode 100644 --- /dev/null +++ b/texbuilder.cabal @@ -0,0 +1,69 @@ +-- Initial tex-builder.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +name: texbuilder +version: 0.1.0.1 +synopsis: View your latex output while editing +description: + This program allows you to view your latex document in your pdf viewer while + editing it in your favorite editor. When you save your document, this program + will recompile it, overwrite the output pdf file and send a signal to your + pdf reader to reload the file. This effectively allows for a + "continous preview"-like experience. + + This will run on Linux only at the moment. +homepage: https://gitlab.com/xaverdh/tex-builder#texbuilder +license: GPL-3 +license-file: LICENSE +author: Dominik Xaver Hörl +maintainer: Dominik Xaver Hörl +-- copyright: +category: LaTeX +build-type: Simple +extra-source-files: ChangeLog.md, README.md +cabal-version: >=1.10 + +executable texbuilder + main-is: Main.hs + + other-modules: TexBuilder.CompileThread + other-modules: TexBuilder.Engine + other-modules: TexBuilder.ChooseEngine + other-modules: TexBuilder.FileFilters + other-modules: TexBuilder.TexBuilder + other-modules: TexBuilder.Utils.BinSem + other-modules: TexBuilder.Utils.File + other-modules: TexBuilder.Utils.Hashing + other-modules: TexBuilder.Utils.Inotify + other-modules: TexBuilder.ViewThread + other-modules: TexBuilder.Watches + + other-extensions: OverloadedStrings + other-extensions: LambdaCase + other-extensions: PackageImports + + build-depends: base >=4.9 && <4.11 + build-depends: optparse-applicative >=0.13 && <0.15 + build-depends: unix >=2.7 && <2.8 + build-depends: process >=1.4 && <1.7 + build-depends: hinotify >=0.3 && <0.4 + build-depends: directory >=1.3 && <1.4 + build-depends: filepath >=1.4 && <1.5 + build-depends: temporary >=1.2 && <1.3 + build-depends: mtl >= 2.2.1 && < 2.3 + build-depends: bytestring >= 0.10.8 && < 0.11 + build-depends: containers >= 0.5.7 && < 0.6 + build-depends: cryptonite >= 0.23 && <= 0.24 + build-depends: deepseq >= 1.4.2 && < 1.5 + build-depends: ansi-wl-pprint >= 0.6.7 && < 0.7 + build-depends: extra >= 1.5.3 && < 1.7 + + -- hs-source-dirs: + + default-language: Haskell2010 + +source-repository head + type: git + location: https://gitlab.com/xaverdh/tex-builder/ + +