├── .gitignore ├── LICENSE ├── Readme.org ├── img ├── screencast.gif └── screenshot.png └── org-latex-impatient.el /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.toptal.com/developers/gitignore/api/emacs 3 | # Edit at https://www.toptal.com/developers/gitignore?templates=emacs 4 | 5 | ### Emacs ### 6 | # -*- mode: gitignore; -*- 7 | *~ 8 | \#*\# 9 | /.emacs.desktop 10 | /.emacs.desktop.lock 11 | *.elc 12 | auto-save-list 13 | tramp 14 | .\#* 15 | 16 | # Org-mode 17 | .org-id-locations 18 | *_archive 19 | 20 | # flymake-mode 21 | *_flymake.* 22 | 23 | # eshell files 24 | /eshell/history 25 | /eshell/lastdir 26 | 27 | # elpa packages 28 | /elpa/ 29 | 30 | # reftex files 31 | *.rel 32 | 33 | # AUCTeX auto folder 34 | /auto/ 35 | 36 | # cask packages 37 | .cask/ 38 | dist/ 39 | 40 | # Flycheck 41 | flycheck_*.el 42 | 43 | # server auth directory 44 | /server/ 45 | 46 | # projectiles files 47 | .projectile 48 | 49 | # directory configuration 50 | .dir-locals.el 51 | 52 | # network security 53 | /network-security.data 54 | 55 | 56 | # End of https://www.toptal.com/developers/gitignore/api/emacs 57 | 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Readme.org: -------------------------------------------------------------------------------- 1 | #+TITLE: org-latex-impatient 2 | =org-latex-impatient= provides instant preview of LaTeX snippets via MathJax outputed SVG. Unlike [[https://github.com/fuxialexander/emacs-webkit-katex-render][webkit-katex-render]], this does not need xwidget support. Currently =org-mode= and its derived modes, e.g. org-journal, are fully supported. =Markdown-mode= support is new, but seems decent as long as you have correct highlight for math fragments. Support for =latex-mode= is experimental and under construction (no support for custom =\newcommand= yet). 3 | [[file:img/screenshot.png]] 4 | * Dependencies 5 | - [[https://github.com/Malabarba/names][Names]] 6 | - [[https://github.com/mathjax/MathJax-node][MathJax-node]] 7 | - [[https://github.com/mathjax/mathjax-node-cli/][MathJax-node-cli]] 8 | - [[https://github.com/tumashu/posframe][posframe]] 9 | 10 | * Installation 11 | You can install =MathJax-node-cli= via ~npm~: 12 | #+BEGIN_SRC shell 13 | npm install mathjax-node-cli 14 | #+END_SRC 15 | You need to set ~org-latex-impatient-tex2svg-bin~ to the location of the executable ~tex2svg~. 16 | 17 | * Usage 18 | #+begin_src emacs-lisp 19 | (use-package org-latex-impatient 20 | :defer t 21 | :hook (org-mode . org-latex-impatient-mode) 22 | :init 23 | (setq org-latex-impatient-tex2svg-bin 24 | ;; location of tex2svg executable 25 | "~/node_modules/mathjax-node-cli/bin/tex2svg")) 26 | #+end_src 27 | Or just enable minor mode ~org-latex-impatient-mode~ manually when it is needed. 28 | [[file:img/screencast.gif]] 29 | 30 | * Customization 31 | - ~org-latex-impatient-delay~: change the number of seconds to wait before re-compilation after Emacs is idle. Default to be 0.1. 32 | - ~org-latex-impatient-tex2svg-bin~: set the location of ~tex2svg~ executable. 33 | - ~org-latex-impatient-border-color~: border color. 34 | - ~org-latex-impatient-border-width~: border width (an integer), 0 will disable border. 35 | - ~org-latex-impatient-scale~: set the scale of the preview. Due to limitations in the way Emacs handles SVG pictures, it is implemented by manipulating SVG directly. 36 | - ~org-latex-impatient-posframe-position~: at which point shall the posframe be positioned. Can take two choices, ~point~ at the current point, or ~tex-end~ at the end of the LaTeX snippet. See the next option for detail. 37 | - ~org-latex-impatient-posframe-position-handler~: set the posframe position handler. 38 | Default value is ~org-latex-impatient-poshandler~, which uses end point of current LaTeX fragment for inline math, and centering right below the end point otherwise. You might want to use ~posframe-poshandler-point-bottom-left-corner~ for showing it using the point specified by ~org-latex-impatient-posframe-position~, or ~posframe-poshandler-point-window-center~ for a position centering right below the end point. Check the documentation of ~posframe-show~ for other options. 39 | - ~org-latex-impatient-user-latex-definitions~: custom LaTeX definitions used in the preview. Should be a list of strings. Default: ~'("\\newcommand{\\ensuremath}[1]{#1}" "\\renewcommand{\\usepackage}[2][]{}")~, which handles ~\ensuremath~ correctly for =MathJax=. In general, it is recommended to add your custom LaTeX command via the following: 40 | #+BEGIN_SRC org 41 | ,#+LATEX_HEADER: \newcommand{\someNewCommand}{Some Definition} 42 | #+END_SRC 43 | - ~org-latex-impatient-inhibit-envs~: a list of LaTeX environments. If a LaTeX fragment contains one of them, preview will be disabled. This exists to avoid previewing environments unsupported by MathJax, e.g. =tikzpicture=. 44 | - ~org-latex-impatient-inhibit-commands~: a list of LaTeX commands. If a LaTeX fragment contains one of them, preview will be disabled. This exists to avoid previewing commands unsupported by MathJax, e.g. =\tikz= 45 | 46 | * FAQ 47 | 48 | ** TeX parse error: Undefined control sequence 49 | There are many LaTeX commands that are not supported by MathJax, therefore also unsupported by =org-latex-impatient-mode=. Mostly, such commands are not important for a preview. 50 | 51 | If this is the case, you can /ignore/ it by override its definition with a place holder in ~org-latex-impatient-user-definitions~. For example, if you are using beamer, you would be calling ~\setbeamertemplate~ in the setup file or header. You will see errors like "TeX parse error: Undefined control sequence =\setbeamercolor=". This is a command that receives two parameters, so you can run 52 | #+begin_src emacs-lisp 53 | (add-to-list 'org-latex-impatient-user-latex-definitions "\\renewcommand{\\setbeamertemplate}[2]{}" t) 54 | #+end_src 55 | It is recommended to override top level commands for obvious reasons. Repeat this process for every such command. 56 | 57 | Since most LaTeX packages are not relevant in math preview, we assume that *all* package usage are not necessary in producing a preview, and override the ~\usepackage~ call in the header. +If this prevents you from using certain commands defined by an external package, add this in the *front* of ~org-latex-impatient-user-latex-definitions~ like the following:+ 58 | # #+begin_src emacs-lisp 59 | # (add-to-list 'org-latex-impatient-user-latex-definitions "\\usepackage{somepackge}") ; 60 | # #+end_src 61 | 62 | * Known Issue 63 | - Some SVG files get cropped slightly more than it should. This happens with =librsvg= 2.45 or below. It can also happen on Emacs 28, problem introduced in commit =8f42b94f= and fixed in =b42481e2=. ([[https://debbugs.gnu.org/cgi/bugreport.cgi?bug=44065][bug #44065]]) 64 | - Some report problem of showing scaled SVG on Mac OSX. A workaround is to avoid customization of ~org-latex-impatient-scale~. 65 | - For ~latex-mode~, currently we do not support customized ~newcommand~ or ~renewcommand~. One workaround is to manually add the definitions to ~org-latex-impatient-user-latex-definitions~. 66 | 67 | * Future Plans 68 | - Add support for ~latex-mode~. There is experimental support, but it does not support any customized commands. Such a support would require either parsing =tex= file, or actually compiling a =tex= file with ~latex/pdflatex/xelatex~. 69 | - Use ~latex/pdflatex/xelatex~ for image generation instead of ~mathjax~. Some progress made, but needs refactoring to make things consistent. 70 | - Support for scaling in different Emacs versions. 71 | 72 | * License 73 | This piece work is licensed under GPLv3. 74 | -------------------------------------------------------------------------------- /img/screencast.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yangsheng6810/org-latex-impatient/031025a8be9bf7255aa047388d027642cd2d6183/img/screencast.gif -------------------------------------------------------------------------------- /img/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yangsheng6810/org-latex-impatient/031025a8be9bf7255aa047388d027642cd2d6183/img/screenshot.png -------------------------------------------------------------------------------- /org-latex-impatient.el: -------------------------------------------------------------------------------- 1 | ;;; org-latex-impatient.el --- Preview org-latex Fragments Instantly via MathJax -*- lexical-binding: t; -*- 2 | ;; 3 | ;; Copyright (C) 2020 Sheng Yang 4 | ;; 5 | ;; Author: Sheng Yang 6 | ;; Created: June 03, 2020 7 | ;; Modified: October 04, 2020 8 | ;; Version: 0.1.0 9 | ;; Keywords: tex,tools 10 | ;; Homepage: https://github.com/yangsheng6810/org-latex-instant-preview 11 | ;; Package-Requires: ((emacs "26") (s "1.8.0") (posframe "0.8.0") (org "9.3") (dash "2.17.0")) 12 | ;; 13 | ;; This file is not part of GNU Emacs. 14 | ;; 15 | ;;; Commentary: 16 | ;; 17 | ;; This package provides instant preview of LaTeX snippets via MathJax outputed 18 | ;; SVG. 19 | ;; 20 | ;;; License: 21 | 22 | ;; This program is free software; you can redistribute it and/or modify 23 | ;; it under the terms of the GNU General Public License as published by 24 | ;; the Free Software Foundation, either version 3 of the License, or 25 | ;; (at your option) any later version. 26 | 27 | ;; This program is distributed in the hope that it will be useful, 28 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 29 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 30 | ;; GNU General Public License for more details. 31 | 32 | ;; You should have received a copy of the GNU General Public License 33 | ;; along with this program. If not, see . 34 | ;;; Code: 35 | ;;; 36 | 37 | (require 'image-mode) 38 | (require 's) 39 | (require 'dash) 40 | (require 'org) 41 | (require 'posframe) 42 | (require 'org-element) 43 | 44 | (defcustom org-latex-impatient-tex2svg-bin "" 45 | "Location of tex2svg executable." 46 | :group 'org-latex-impatient 47 | :type '(string)) 48 | 49 | (defcustom org-latex-impatient-delay 0.1 50 | "Number of seconds to wait before a re-compilation." 51 | :group 'org-latex-impatient 52 | :type '(number)) 53 | 54 | (defcustom org-latex-impatient-scale 1.0 55 | "Scale of preview." 56 | :group 'org-latex-impatient 57 | :type '(float)) 58 | 59 | (defcustom org-latex-impatient-border-color "black" 60 | "Color of preview border." 61 | :group 'org-latex-impatient 62 | :type '(color)) 63 | 64 | (defcustom org-latex-impatient-border-width 1 65 | "Width of preview border." 66 | :group 'org-latex-impatient 67 | :type '(integer)) 68 | 69 | (defcustom org-latex-impatient-user-latex-definitions 70 | '("\\newcommand{\\ensuremath}[1]{#1}" 71 | "\\renewcommand{\\usepackage}[2][]{}") 72 | "Custom LaTeX definitions used in preview. 73 | 74 | \\usepackage redefined since MathJax does not support it" 75 | :group 'org-latex-impatient 76 | :type '(repeat string)) 77 | 78 | (defcustom org-latex-impatient-posframe-position-handler 79 | #'org-latex-impatient-poshandler 80 | "The handler for posframe position." 81 | :group 'org-latex-impatient 82 | :type '(function)) 83 | 84 | (defcustom org-latex-impatient-posframe-position 85 | 'tex-end 86 | "The position that will be used by posframe handler." 87 | :group 'org-latex-impatient 88 | :type '(choice (const :tag "Current Point" point) 89 | (const :tag "End of TeX String" tex-end))) 90 | 91 | (defcustom org-latex-impatient-inhibit-envs 92 | '("tikzpicture") 93 | "List of environments that shall not preview" 94 | :group 'org-latex-impatient 95 | :type '(repeat string)) 96 | 97 | (defcustom org-latex-impatient-inhibit-commands 98 | '("\\tikz") 99 | "List of commands that shall not preview" 100 | :group 'org-latex-impatient 101 | :type '(repeat string)) 102 | 103 | (defconst org-latex-impatient--output-buffer-prefix "*org-latex-impatient*" 104 | "Prefix for buffer to hold the output.") 105 | 106 | (defconst org-latex-impatient--posframe-buffer "*org-latex-impatient*" 107 | "Buffer to hold the preview.") 108 | 109 | (defvar org-latex-impatient-keymap 110 | (let ((map (make-sparse-keymap))) 111 | (define-key map "\C-g" #'org-latex-impatient-abort-preview) 112 | map) 113 | "Keymap for reading input.") 114 | 115 | (defvar org-latex-impatient--process nil) 116 | (defvar org-latex-impatient--timer nil) 117 | (defvar-local org-latex-impatient--last-tex-string nil) 118 | (defvar-local org-latex-impatient--last-position nil) 119 | (defvar-local org-latex-impatient--position nil) 120 | (defvar-local org-latex-impatient--last-preview nil) 121 | (defvar-local org-latex-impatient--current-window nil) 122 | (defvar-local org-latex-impatient--output-buffer nil) 123 | (defvar-local org-latex-impatient--is-inline nil) 124 | (defvar-local org-latex-impatient--force-hidden nil) 125 | 126 | (defun org-latex-impatient-poshandler (info) 127 | "Default position handler for posframe. 128 | 129 | Uses the end point of the current LaTeX fragment for inline math, 130 | and centering right below the end point otherwise. Positions are 131 | calculated from INFO." 132 | (if org-latex-impatient--is-inline 133 | (posframe-poshandler-point-bottom-left-corner info) 134 | (if (fboundp 'posframe-poshandler-point-window-center) 135 | (posframe-poshandler-point-window-center info) 136 | (org-latex-impatient--poshandler-point-window-center info)))) 137 | 138 | (defun org-latex-impatient--poshandler-point-window-center (info) 139 | "Posframe's position handler. 140 | 141 | Get a position which let posframe stay right below current 142 | position, centered in the current window. The structure of INFO 143 | can be found in docstring of `posframe-show'. 144 | 145 | This function will be removed once a similar poshandler is 146 | available in upstream." 147 | (let* ((window-left (plist-get info :parent-window-left)) 148 | (window-width (plist-get info :parent-window-width)) 149 | (posframe-width (plist-get info :posframe-width)) 150 | (posframe-height (plist-get info :posframe-height)) 151 | (y-pixel-offset (plist-get info :y-pixel-offset)) 152 | (ymax (plist-get info :parent-frame-height)) 153 | (window (plist-get info :parent-window)) 154 | (position-info (plist-get info :position-info)) 155 | (header-line-height (plist-get info :header-line-height)) 156 | (tab-line-height (plist-get info :tab-line-height)) 157 | (y-top (+ (cadr (window-pixel-edges window)) 158 | tab-line-height 159 | header-line-height 160 | (- (or (cdr (posn-x-y position-info)) 0) 161 | ;; Fix the conflict with flycheck 162 | ;; https://lists.gnu.org/archive/html/emacs-devel/2018-01/msg00537.html 163 | (or (cdr (posn-object-x-y position-info)) 0)) 164 | y-pixel-offset)) 165 | (font-height (plist-get info :font-height)) 166 | (y-bottom (+ y-top font-height))) 167 | (cons (+ window-left (/ (- window-width posframe-width) 2)) 168 | (max 0 (if (> (+ y-bottom (or posframe-height 0)) ymax) 169 | (- y-top (or posframe-height 0)) 170 | y-bottom))))) 171 | 172 | (defun org-latex-impatient--clean-up () 173 | "Clean up timer, process, and variables." 174 | (org-latex-impatient--hide) 175 | (when org-latex-impatient--process 176 | (kill-process org-latex-impatient--process)) 177 | (when (get-buffer org-latex-impatient--output-buffer) 178 | (let ((kill-buffer-query-functions nil)) 179 | (kill-buffer org-latex-impatient--output-buffer))) 180 | (setq org-latex-impatient--process nil 181 | org-latex-impatient--last-tex-string nil 182 | org-latex-impatient--last-position nil 183 | org-latex-impatient--current-window nil)) 184 | 185 | ;;;###autoload 186 | (defun org-latex-impatient-stop () 187 | "Stop instant preview of LaTeX snippets." 188 | (interactive) 189 | ;; only needed for manual start/stop 190 | (remove-hook 'after-change-functions #'org-latex-impatient--prepare-timer t) 191 | (org-latex-impatient--hide) 192 | (org-latex-impatient--interrupt-rendering)) 193 | 194 | (defun org-latex-impatient--prepare-timer (&rest _) 195 | "Prepare timer to call re-compilation." 196 | (when org-latex-impatient--timer 197 | (cancel-timer org-latex-impatient--timer) 198 | (setq org-latex-impatient--timer nil)) 199 | (if (and (or (derived-mode-p 'org-mode) 200 | (derived-mode-p 'latex-mode) 201 | (derived-mode-p 'markdown-mode)) 202 | (org-latex-impatient--in-latex-p)) 203 | (setq org-latex-impatient--timer 204 | (run-with-idle-timer org-latex-impatient-delay nil #'org-latex-impatient-start)) 205 | (org-latex-impatient--hide))) 206 | 207 | (defun org-latex-impatient--remove-math-delimeter (ss) 208 | "Chop LaTeX delimeters from SS." 209 | (unless org-latex-impatient--is-inline 210 | (setq org-latex-impatient--is-inline 211 | (or (s-starts-with? "\\(" ss) 212 | (s-starts-with? "$" ss)))) 213 | (s-with ss 214 | (s-chop-prefixes '("$$" "\\(" "$" "\\[")) 215 | (s-chop-suffixes '("$$" "\\)" "$" "\\]")))) 216 | 217 | (defun org-latex-impatient--add-color (ss) 218 | "Wrap SS with color from default face." 219 | (let ((color (face-foreground 'default))) 220 | (format "\\color{%s}{%s}" color ss))) 221 | 222 | (defun org-latex-impatient--equal-or-member (elm target) 223 | (if (listp target) 224 | (member elm target) 225 | (equal elm target))) 226 | 227 | (defun org-latex-impatient--in-latex-p () 228 | "Return t if current point is in a LaTeX fragment, nil otherwise." 229 | (cond ((derived-mode-p 'org-mode) 230 | (let ((datum (org-element-context))) 231 | (or (memq (org-element-type datum) '(latex-environment latex-fragment)) 232 | (and (memq (org-element-type datum) '(export-block)) 233 | (equal (org-element-property :type datum) "LATEX"))))) 234 | ((derived-mode-p 'latex-mode) 235 | (org-latex-impatient--tex-in-latex-p)) 236 | ((derived-mode-p 'markdown-mode) 237 | (org-latex-impatient--equal-or-member 'markdown-math-face (get-text-property (point) 'face))) 238 | (t (message "We only support org-mode, latex-mode, and markdown-mode") 239 | nil))) 240 | 241 | (defun org-latex-impatient--tex-in-latex-p () 242 | "Return t if in LaTeX fragment in `latex-mode', nil otherwise." 243 | (let ((faces (face-at-point nil t))) 244 | (or (-contains? faces 'font-latex-math-face) 245 | (-contains? faces 'preview-face)))) 246 | 247 | (defun org-latex-impatient--has-latex-overlay () 248 | "Return t if there is LaTeX overlay showing." 249 | (--first (or (overlay-get it 'xenops-overlay-type) 250 | (equal 'org-latex-overlay (overlay-get it 'org-overlay-type))) 251 | (append (overlays-at (point)) (overlays-at (1- (point)))))) 252 | 253 | (defun org-latex-impatient--get-tex-string () 254 | "Return the string of LaTeX fragment." 255 | (cond ((derived-mode-p 'org-mode) 256 | (let ((datum (org-element-context))) 257 | (org-element-property :value datum))) 258 | ((derived-mode-p 'latex-mode) 259 | (let (begin end) 260 | (save-excursion 261 | (while (org-latex-impatient--tex-in-latex-p) 262 | (backward-char)) 263 | (setq begin (1+ (point)))) 264 | (save-excursion 265 | (while (org-latex-impatient--tex-in-latex-p) 266 | (forward-char)) 267 | (setq end (point))) 268 | (let ((ss (buffer-substring-no-properties begin end))) 269 | (message "ss is %S" ss) 270 | ss))) 271 | ((derived-mode-p 'markdown-mode) 272 | (let (begin end) 273 | (save-excursion 274 | (setq begin (prop-match-beginning 275 | (text-property--find-end-backward 276 | (point) 'face 'markdown-math-face #'yang/equal-or-member)))) 277 | (save-excursion 278 | (setq end (prop-match-end 279 | (text-property--find-end-forward 280 | (point) 'face 'markdown-math-face #'yang/equal-or-member))) 281 | (unless (looking-at (rx (or "$$" "\\]"))) 282 | (setq org-latex-impatient--is-inline t) 283 | (message "setting is-line to %s" org-latex-impatient--is-inline))) 284 | (let ((ss (buffer-substring-no-properties begin end))) 285 | (message "ss is %S" ss) 286 | ss))) 287 | (t ""))) 288 | 289 | (defun org-latex-impatient--get-tex-position () 290 | "Return the end position of LaTeX fragment." 291 | (cond ((eq org-latex-impatient-posframe-position 'tex-end) 292 | (cond ((derived-mode-p 'org-mode) 293 | (let ((datum (org-element-context))) 294 | (org-element-property :end datum))) 295 | ((derived-mode-p 'latex-mode) 296 | (save-excursion 297 | (while (org-latex-impatient--tex-in-latex-p) 298 | (forward-char)) 299 | (point))) 300 | ((derived-mode-p 'markdown-mode) 301 | (save-excursion 302 | (prop-match-end 303 | (text-property--find-end-forward 304 | (point) 'face 'markdown-math-face #'yang/equal-or-member)))) 305 | (t (message "Only org-mode, latex-mode, and markdown-mode supported") nil))) 306 | ((eq org-latex-impatient-posframe-position 'point) 307 | (point)) 308 | (t (message "org-latex-impatient-posframe-position set incorrectly")))) 309 | 310 | (defun org-latex-impatient--need-remove-delimeters () 311 | "Return t if need to remove delimeters." 312 | (cond ((derived-mode-p 'org-mode) 313 | (let ((datum (org-element-context))) 314 | (memq (org-element-type datum) '(latex-fragment)))) 315 | ((derived-mode-p 'latex-mode) 316 | ;; (message "Not implemented.") 317 | t) 318 | ((derived-mode-p 'markdown-mode) 319 | ;; (message "Not implemented.") 320 | t) 321 | (t ""))) 322 | 323 | (defun org-latex-impatient--get-headers () 324 | "Return a string of headers." 325 | (cond ((derived-mode-p 'org-mode) 326 | (plist-get (org-export-get-environment 327 | (org-export-get-backend 'latex)) 328 | :latex-header)) 329 | ((derived-mode-p 'latex-mode) 330 | ;; (message "Get header not supported in latex-mode yet.") 331 | "") 332 | ((derived-mode-p 'markdown-mode) 333 | ;; (message "Get header not supported in markdown-mode yet.") 334 | "") 335 | (t ""))) 336 | 337 | (defun org-latex-impatient-inhibit (tex-string) 338 | "Returns t if we do not want TEX-STRING to preview." 339 | ;; checks for tikz 340 | (or (s-matches-p 341 | (rx-to-string 342 | `(: "\\begin{" (or ,@org-latex-impatient-inhibit-envs))) 343 | tex-string) 344 | (s-matches-p 345 | (rx-to-string 346 | `(or ,@org-latex-impatient-inhibit-commands)) 347 | tex-string))) 348 | 349 | ;;;###autoload 350 | (defun org-latex-impatient-start (&rest _) 351 | "Start instant preview." 352 | (interactive) 353 | (unless (and (not (string= org-latex-impatient-tex2svg-bin "")) 354 | (executable-find org-latex-impatient-tex2svg-bin)) 355 | (message "You need to set org-latex-impatient-tex2svg-bin 356 | for instant preview to work!") 357 | (error "Variable org-latex-impatient-tex2svg-bin is not set correctly")) 358 | 359 | ;; Only used for manual start 360 | (when (equal this-command #'org-latex-impatient-start) 361 | (add-hook 'after-change-functions #'org-latex-impatient--prepare-timer nil t)) 362 | 363 | (if (and (or (derived-mode-p 'org-mode) 364 | (derived-mode-p 'latex-mode) 365 | (derived-mode-p 'markdown-mode)) 366 | (org-latex-impatient--in-latex-p) 367 | (not (org-latex-impatient--has-latex-overlay))) 368 | (let ((--dummy-- (setq org-latex-impatient--is-inline nil)) 369 | (tex-string (org-latex-impatient--get-tex-string)) 370 | (latex-header 371 | (concat (s-join "\n" org-latex-impatient-user-latex-definitions) 372 | "\n" 373 | (org-latex-impatient--get-headers)))) 374 | (unless (org-latex-impatient-inhibit tex-string) 375 | (setq org-latex-impatient--current-window (selected-window)) 376 | ;; the tex string from latex-fragment includes math delimeters like 377 | ;; $, $$, \(\), \[\], and we need to remove them. 378 | (when (org-latex-impatient--need-remove-delimeters) 379 | (setq tex-string (org-latex-impatient--remove-math-delimeter tex-string))) 380 | 381 | (setq org-latex-impatient--position (org-latex-impatient--get-tex-position) 382 | ;; set forground color for LaTeX equations. 383 | tex-string (concat latex-header 384 | (org-latex-impatient--add-color tex-string))) 385 | (if (and org-latex-impatient--last-tex-string 386 | (equal tex-string 387 | org-latex-impatient--last-tex-string)) 388 | ;; TeX string is the same, we only need to update posframe 389 | ;; position. 390 | (when (and org-latex-impatient--last-position 391 | (equal org-latex-impatient--position org-latex-impatient--last-position) 392 | ;; do not force showing posframe when a render 393 | ;; process is running. 394 | (not org-latex-impatient--process) 395 | (not org-latex-impatient--force-hidden)) 396 | (org-latex-impatient--show)) 397 | ;; reset `-force-hidden' 398 | (setq org-latex-impatient--force-hidden nil) 399 | ;; A new rendering is needed. 400 | (org-latex-impatient--interrupt-rendering) 401 | (org-latex-impatient--render tex-string)))) 402 | ;; Hide posframe when not on LaTeX 403 | (org-latex-impatient--hide))) 404 | 405 | (defun org-latex-impatient--interrupt-rendering () 406 | "Interrupt current running rendering." 407 | (when org-latex-impatient--process 408 | (condition-case nil 409 | (kill-process org-latex-impatient--process) 410 | (error "Faild to kill process")) 411 | (setq org-latex-impatient--process nil 412 | ;; last render for tex string is invalid, therefore need to invalid 413 | ;; its cache 414 | org-latex-impatient--last-tex-string nil 415 | org-latex-impatient--last-preview nil)) 416 | (when (get-buffer org-latex-impatient--output-buffer) 417 | (let ((kill-buffer-query-functions nil)) 418 | (kill-buffer org-latex-impatient--output-buffer)))) 419 | 420 | (defun org-latex-impatient--render (tex-string) 421 | "Render TEX-STRING to buffer, async version. 422 | 423 | Showing at point END" 424 | (let (message-log-max) 425 | (message "Instant LaTeX rendering")) 426 | (org-latex-impatient--interrupt-rendering) 427 | (setq org-latex-impatient--last-tex-string tex-string) 428 | (setq org-latex-impatient--last-position org-latex-impatient--position) 429 | (get-buffer-create org-latex-impatient--output-buffer) 430 | 431 | (setq org-latex-impatient--process 432 | (make-process 433 | :name "org-latex-impatient" 434 | :buffer org-latex-impatient--output-buffer 435 | :command (append (list org-latex-impatient-tex2svg-bin 436 | tex-string) 437 | (when org-latex-impatient--is-inline 438 | '("--inline"))) 439 | ;; :stderr ::my-err-buffer 440 | :sentinel 441 | (lambda (&rest _) 442 | (condition-case nil 443 | (progn 444 | (org-latex-impatient--fill-posframe-buffer) 445 | (org-latex-impatient--show) 446 | (when (get-buffer org-latex-impatient--output-buffer) 447 | (let ((kill-buffer-query-functions nil)) 448 | (kill-buffer org-latex-impatient--output-buffer)))) 449 | (error nil)) 450 | ;; ensure -process is reset 451 | (setq org-latex-impatient--process nil))))) 452 | 453 | (defun org-latex-impatient--insert-into-posframe-buffer (ss) 454 | "Insert SS into posframe buffer." 455 | (buffer-disable-undo org-latex-impatient--posframe-buffer) 456 | (let ((inhibit-message t) 457 | (message-log-max nil)) 458 | (with-current-buffer org-latex-impatient--posframe-buffer 459 | (image-mode-as-text) 460 | (erase-buffer) 461 | (insert ss) 462 | (image-mode)))) 463 | 464 | (defun org-latex-impatient--fill-posframe-buffer () 465 | "Write SVG in posframe buffer." 466 | (let ((ss (with-current-buffer org-latex-impatient--output-buffer 467 | (buffer-string)))) 468 | (unless (get-buffer org-latex-impatient--posframe-buffer) 469 | (get-buffer-create org-latex-impatient--posframe-buffer)) 470 | ;; when compile error, ss is exactly the error message, so we do nothing. 471 | ;; Otherwise when compile succeed and need scaling, do some hacks 472 | (when (and (s-contains-p "svg" ss) 473 | (not (equal org-latex-impatient-scale 1.0))) 474 | (setq ss 475 | (concat 476 | ;; 100% seems wierd 477 | "" 478 | ;; ad-hoc for scaling 479 | (format "" org-latex-impatient-scale) 480 | ss 481 | ""))) 482 | (org-latex-impatient--insert-into-posframe-buffer ss) 483 | (setq org-latex-impatient--last-preview ss))) 484 | 485 | (defun org-latex-impatient--show (&optional display-point) 486 | "Show preview posframe at DISPLAY-POINT." 487 | (unless display-point 488 | (setq display-point org-latex-impatient--position)) 489 | (when (and org-latex-impatient--current-window 490 | (posframe-workable-p) 491 | (<= (window-start) display-point (window-end)) 492 | (not org-latex-impatient--force-hidden)) 493 | (unless (get-buffer org-latex-impatient--posframe-buffer) 494 | (get-buffer-create org-latex-impatient--posframe-buffer) 495 | (when (and org-latex-impatient--last-preview 496 | (not (string= "" org-latex-impatient--last-preview))) 497 | ;; use cached preview 498 | (org-latex-impatient--insert-into-posframe-buffer org-latex-impatient--last-preview))) 499 | (let ((temp org-latex-impatient--is-inline)) 500 | (with-current-buffer org-latex-impatient--posframe-buffer 501 | (setq org-latex-impatient--is-inline temp))) 502 | 503 | ;; handle C-g 504 | (define-key org-latex-impatient-keymap (kbd "C-g") #'org-latex-impatient-abort-preview) 505 | (posframe-show org-latex-impatient--posframe-buffer 506 | :position display-point 507 | :poshandler org-latex-impatient-posframe-position-handler 508 | :parent-window org-latex-impatient--current-window 509 | :internal-border-width org-latex-impatient-border-width 510 | :internal-border-color org-latex-impatient-border-color 511 | :hidehandler #'posframe-hidehandler-when-buffer-switch))) 512 | 513 | (defun org-latex-impatient--hide () 514 | "Hide preview posframe." 515 | (define-key org-latex-impatient-keymap (kbd "C-g") nil) 516 | (posframe-hide org-latex-impatient--posframe-buffer) 517 | (when (get-buffer org-latex-impatient--posframe-buffer) 518 | (setq org-latex-impatient--last-preview 519 | (with-current-buffer org-latex-impatient--posframe-buffer 520 | (let ((inhibit-message t) 521 | (message-log-max nil)) 522 | (image-mode-as-text) 523 | (buffer-substring-no-properties (point-min) (point-max))))) 524 | (kill-buffer org-latex-impatient--posframe-buffer))) 525 | 526 | (defun org-latex-impatient-abort-preview () 527 | "Abort preview." 528 | (interactive) 529 | (org-latex-impatient--interrupt-rendering) 530 | (define-key org-latex-impatient-keymap (kbd "C-g") nil) 531 | (setq org-latex-impatient--force-hidden t) 532 | (org-latex-impatient--hide)) 533 | 534 | ;;;###autoload 535 | (define-minor-mode org-latex-impatient-mode 536 | "Instant preview of LaTeX in org-mode" 537 | :global nil 538 | :init-value nil 539 | :keymap org-latex-impatient-keymap 540 | (if org-latex-impatient-mode 541 | (progn 542 | (setq org-latex-impatient--output-buffer 543 | (concat org-latex-impatient--output-buffer-prefix (buffer-name))) 544 | (add-hook 'post-command-hook #'org-latex-impatient--prepare-timer nil t)) 545 | (remove-hook 'post-command-hook #'org-latex-impatient--prepare-timer t) 546 | (org-latex-impatient-stop))) 547 | 548 | (provide 'org-latex-impatient) 549 | ;;; org-latex-impatient.el ends here 550 | --------------------------------------------------------------------------------