branch: elpa/diff-ansi
commit f2207a67e3cc79433b43deeb463d0768357c350f
Author: Campbell Barton <ideasma...@gmail.com>
Commit: Campbell Barton <ideasma...@gmail.com>
Initial diff-ansi.
---
.elisp-autofmt | 0
LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++
diff-ansi.el | 961 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
readme.rst | 111 +++++++
4 files changed, 1746 insertions(+)
diff --git a/.elisp-autofmt b/.elisp-autofmt
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000000..f288702d2f
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/diff-ansi.el b/diff-ansi.el
new file mode 100644
index 0000000000..5bc148e7db
--- /dev/null
+++ b/diff-ansi.el
@@ -0,0 +1,961 @@
+;;; diff-ansi.el --- Display diff's using alternative diffing tools -*-
lexical-binding: t -*-
+
+;; Copyright (C) 2021 Campbell Barton
+
+;; Author: Campbell Barton <ideasma...@gmail.com>
+
+;; URL: https://gitlab.com/ideasman42/emacs-diff-ansi
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; Support showing diffs using external tools.
+
+;;; Usage
+
+;; See readme.rst.
+;;
+
+;;; Code:
+(require 'ansi-color)
+
+;; ---------------------------------------------------------------------------
+;; Custom Variables
+
+(defgroup diff-ansi nil
+ "Configure smooth scrolling when jumping to new locations."
+ :group 'scrolling)
+
+(defcustom diff-ansi-use-magit-revision-diff t
+ "Use diff-ansi for `magit-revision-mode'."
+ :type 'boolean)
+
+
+(defcustom diff-ansi-tool 'delta
+ "Command to use for generating the diff."
+ :type
+ '
+ (choice
+ (symbol :tag "Use `delta' command." delta)
+ (symbol :tag "Use `diff-so-fancy' command." diff-so-fancy)
+ (symbol :tag "Use `ydiff' command." ydiff)
+
+ (symbol :tag "Use `diff-ansi-tool-custom' command." custom)))
+
+;; Note that this has it's values extracted and isn't used directly.
+(defface diff-ansi-default-face
+ (list (list t :foreground "black" :background "black"))
+ "Face used to render black color.")
+
+(defcustom diff-ansi-tool-custom nil
+ "Command to use when `diff-ansi-tool' is set to `custom'.
+This must take the diff content as the `standard-input'."
+ :type '(repeat string))
+
+;; Extra arguments for command presets.
+
+(defcustom diff-ansi-extra-args-for-delta
+ (list "--side-by-side" "--no-gitconfig" "--syntax-theme=github"
"--true-color=always")
+ "Additional arguments to pass to `delta'."
+ :type '(repeat string))
+
+(defcustom diff-ansi-extra-args-for-diff-so-fancy (list)
+ "Additional arguments to pass to `diff-so-fancy'."
+ :type '(repeat string))
+
+(defcustom diff-ansi-extra-args-for-ydiff (list "--side-by-side")
+ "Additional arguments to pass to `ydiff'."
+ :type '(repeat string))
+
+;; ---------------------------------------------------------------------------
+;; Custom Variables (Advanced)
+
+(defcustom diff-ansi-method 'multiprocess
+ "Convert ANSI escape sequences."
+ :type
+ '
+ (choice
+ (symbol :tag "Convert immediately." immediate)
+ (symbol :tag "Convert progressively (using a timer)." progressive)
+ (symbol :tag "Convert using multiple sub-processes." multiprocess)))
+
+(defcustom diff-ansi-chunks-size 16384
+ "Number of characters to process at once.
+Used for `progressive' and `multiprocess' methods."
+ :type 'integer)
+
+(defcustom diff-ansi-multiprocess-jobs nil
+ "Number of simultaneous jobs to launch when using `multiprocess' method.
+
+A nil value detects the number of processes on the system (when supported)."
+ :type 'integer)
+
+;; ---------------------------------------------------------------------------
+;; Internal Variables
+
+(defvar-local diff-ansi--ansi-color-timer nil)
+
+(defvar diff-ansi--ansi-color-bg nil)
+
+(defconst diff-ansi--code-block-for-multiprocess-defs
+ ;; NOTE:
+ ;; - `diff-ansi--face-has-bg' is a bit heavy but necessary
+ ;; to ensure all faces have a black-background.
+ ;; - A single `let' or `progn' is needed for the code to be properly quoted.
+ (quote
+ (progn
+ (defun diff-ansi--face-has-bg (face)
+ (when (and face (listp face))
+ (or
+ (plist-get face :background)
+ (diff-ansi--face-has-bg (car face))
+ (diff-ansi--face-has-bg (cdr-safe face)))))
+
+ (defun diff-ansi--ansi-color-apply-text-property-face--local (beg end
face)
+ (when face
+ (unless (diff-ansi--face-has-bg face)
+ (setq face
+ (cond
+ ((listp face)
+ (list face diff-ansi--ansi-color-bg))
+ (t
+ (cons face diff-ansi--ansi-color-bg)))))
+ (put-text-property beg end 'face face)))
+
+ (defun diff-ansi--ansi-color-apply-on-region-with-bg-impl (beg end)
+ (let
+ (
+ (ansi-color-apply-face-function
+ #'diff-ansi--ansi-color-apply-text-property-face--local))
+ (put-text-property beg end 'face diff-ansi--ansi-color-bg)
+ (ansi-color-apply-on-region beg end))))))
+
+;; Evaluate locally too.
+(eval diff-ansi--code-block-for-multiprocess-defs)
+
+;; Needed since the the `eval' causes the function to be hidden.
+(declare-function diff-ansi--ansi-color-apply-on-region-with-bg-impl
"diff-ansi")
+
+
+;; ---------------------------------------------------------------------------
+;; Generic functions.
+
+(defmacro diff-ansi--with-advice (fn-orig where fn-advice &rest body)
+ "Execute BODY with advice added WHERE.
+Argument FN-ADVICE temporarily added to FN-ORIG."
+ `
+ (let ((fn-advice-var ,fn-advice))
+ (unwind-protect
+ (progn
+ (advice-add ,fn-orig ,where fn-advice-var)
+ ,@body)
+ (advice-remove ,fn-orig fn-advice-var))))
+
+(defmacro diff-ansi--with-temp-echo-area (&rest body)
+ "Run BODY with the message temporarily overwritten."
+ `
+ (let ((omessage (current-message)))
+ (unwind-protect
+ (progn
+ ,@body)
+ (let ((message-log-max nil))
+ (message omessage)))))
+
+(defmacro diff-ansi--with-temp-directory (name &rest body)
+ "Bind NAME to the name of a new temporary file and evaluate BODY.
+Delete the temporary file after BODY exits normally or non-locally.
+NAME will be bound to the file name of the temporary file.
+
+The following keyword arguments are supported:
+
+:prefix STRING
+ If non-nil, pass STRING to `make-temp-file' as the PREFIX argument.
+
+:suffix STRING
+ If non-nil, pass STRING to `make-temp-file' as the SUFFIX argument."
+ (declare (indent 1) (debug (symbolp body)))
+ (unless (symbolp name)
+ (error "Expected name to be as symbol, found %S" (type-of name)))
+ (let
+ (
+ (keyw nil)
+ (prefix nil)
+ (suffix nil)
+ (extra-keywords nil))
+ (while (keywordp (setq keyw (car body)))
+ (setq body (cdr body))
+ (pcase keyw
+ (:prefix (setq prefix (pop body)))
+ (:suffix (setq suffix (pop body)))
+ (_ (push keyw extra-keywords) (pop body))))
+ (when extra-keywords
+ (error "Invalid keywords: %s" (mapconcat #'symbol-name extra-keywords "
")))
+ (let
+ (
+ (temp-file (make-symbol "temp-file"))
+ (prefix (or prefix ""))
+ (suffix (or suffix "")))
+ `
+ (let*
+ (
+ (,temp-file (file-name-as-directory (make-temp-file ,prefix t
,suffix nil)))
+ (,name (file-name-as-directory ,temp-file)))
+ (unwind-protect
+ (progn
+ ,@body)
+ (ignore-errors (delete-directory ,temp-file :recursive)))))))
+
+;; See: https://emacs.stackexchange.com/a/70105/2418
+(defun diff-ansi--call-process-pipe-chain (&rest args)
+ "Call a chain of commands in ARGS, each argument must be a list of strings.
+
+Additional keyword arguments may also be passed in.
+
+:input - is used to pipe input into the first commands `standard-input'.
+- nil: no input is passed in.
+- string: text to be passed to the standard input.
+- buffer: buffer to be passed to the standard input
+
+:output - is used as the target for the final commands output.
+- nil: output is ignored.
+- t: output is returned as a string.
+- string: output is written to file-name.
+- buffer: output is written to the buffer."
+ (let
+ ( ;; To check if this is the first time executing.
+ (is-first t)
+
+ ;; Keywords.
+ (output nil)
+ (input nil)
+
+ ;; Iteration vars.
+ (buf-src nil)
+ (buf-dst nil))
+
+ ;; Parse keywords.
+ (let ((args-no-keywords nil))
+ (while args
+ (let ((arg-current (pop args)))
+ (cond
+ ((keywordp arg-current)
+ (unless args
+ (error "Keyword argument %S has no value!" arg-current))
+ (let ((v (pop args)))
+ (pcase arg-current
+ (:input
+ (cond
+ ((null v)) ;; No input.
+ ((eq v t)) ;; String input (standard input data).
+ ((stringp v))
+ ((bufferp v)
+ (unless (buffer-live-p v)
+ (error "Input buffer is invalid %S" v)))
+ (t
+ (error "Input expected a buffer, string or nil")))
+ (setq input v))
+ (:output
+ (cond
+ ((null output)) ;; No output.
+ ((eq output t)) ;; String output (file path).
+ ((stringp output)
+ (when (string-equal output "")
+ (error "Empty string used as file-path")))
+ ((bufferp output)
+ (unless (buffer-live-p output)
+ (error "Input buffer is invalid %S" output)))
+
+ (t
+ (error "Output expected a buffer, string or nil")))
+ (setq output v))
+
+ (_ (error "Unknown argument %S" arg-current)))))
+ ((listp arg-current)
+ (push arg-current args-no-keywords))
+ (t
+ (error
+ "Arguments must be keyword, value pairs or lists of strings,
found %S = %S"
+ (type-of arg-current)
+ arg-current)))))
+
+ (setq args (reverse args-no-keywords)))
+
+ ;; Setup two temporary buffers for source and destination,
+ ;; looping over arguments, executing and piping contents.
+ (with-temp-buffer
+ (setq buf-src (current-buffer))
+ (with-temp-buffer
+ (setq buf-dst (current-buffer))
+
+ ;; Loop over commands.
+ (while args
+ (let ((arg-current (pop args)))
+ (with-current-buffer buf-dst (erase-buffer))
+ (let*
+ (
+ (sentinel-called nil)
+ (proc
+ (make-process
+ :name "call-process-pipe-chain"
+ :buffer
+ (cond
+ ;; Last command, use output.
+ ((and (null args) (bufferp output))
+ output)
+ (t
+ buf-dst))
+ ;; Write to the intermediate buffer or the final output.
+ :connection-type 'pipe
+ :command arg-current
+ :sentinel (lambda (_proc _msg) (setq sentinel-called t)))))
+
+ (cond
+ ;; Initially, we can only use the input argument.
+ (is-first
+ (cond
+ ((null input))
+ ((bufferp input)
+ (with-current-buffer input
+ (process-send-region proc (point-min) (point-max))))
+ ((stringp input)
+ (process-send-string proc input))))
+ (t
+ (with-current-buffer buf-src
+ (process-send-region proc (point-min) (point-max))
+ (erase-buffer))))
+
+ (process-send-eof proc)
+ (while (not sentinel-called)
+ (accept-process-output))
+
+ ;; Check exit-code.
+ (let ((exit-code (process-exit-status proc)))
+ (unless (zerop exit-code)
+ (error "Command exited code=%d: %S" exit-code arg-current))))
+
+ ;; Swap source/destination buffers.
+ (setq buf-src
+ (prog1 buf-dst
+ (setq buf-dst buf-src)))
+
+ (setq is-first nil)))
+
+ ;; Return the result.
+ (cond
+ ;; Ignore output.
+ ((null output))
+ ;; Already written into.
+ ((bufferp output))
+ ;; Write to the output as a file-path.
+ ((stringp output)
+ (with-current-buffer buf-src (write-region nil nil output nil 0)))
+ ;; Return the output as a string.
+ ((eq output t)
+ ;; Since the argument was swapped, extract from the 'source'.
+ (with-current-buffer buf-src
+ (buffer-substring-no-properties (point-min) (point-max)))))))))
+
+(defun diff-ansi--call-process-parallel (args &rest keywords)
+ "Return the result of commands in ARGS.
+
+ARGS must be a list of commands (themselves a list of strings).
+
+Optional keywords in KEYWORDS.
+
+:idle FLOAT
+ The time (in seconds) to idle between checking for each processes result.
+
+:jobs INTEGER
+ The maximum number of processes to run at once.
+
+:output BOOLEAN / FUNCTION
+ The destination for the output.
+
+ - nil: ignores output.
+ - t: returns the result as an array of strings.
+ - function: runs the function with argument index & string result arguments.
+
+:progress-message STRING
+ When set, show progress percentage."
+ (let
+ ( ;; Keyword arguments.
+ (idle nil)
+ (jobs nil)
+ (output nil)
+ (output-is-fn nil)
+ (progress-message nil))
+
+ ;; Parse keywords.
+ (while keywords
+ (let ((arg-current (pop keywords)))
+ (cond
+ ((keywordp arg-current)
+ (unless keywords
+ (error "Keyword argument %S has no value!" arg-current))
+ (let ((v (pop keywords)))
+ (pcase arg-current
+ (:idle
+ (cond
+ ((null v)) ;; Ignore.
+ ((floatp v))
+ (t
+ (error "Argument :idle expected a float, not a %S"
(type-of v))))
+ (setq idle v))
+
+ (:jobs
+ (cond
+ ((null v)) ;; Ignore.
+ ((eq v t)) ;; String output (result vector)
+ ((symbolp v))
+ (t
+ (error "Output expected nil, t or a symbol")))
+ (setq jobs v))
+
+ (:output
+ (cond
+ ((null v)) ;; Ignore.
+ ((eq v t)) ;; String output (result vector)
+ ((functionp v)
+ (setq output-is-fn t))
+ (t
+ (error "Output expected nil, t or a symbol, not a %S"
(type-of v))))
+ (setq output v))
+
+ (:progress-message
+ (cond
+ ((null v)) ;; Ignore.
+ ((stringp v)
+ (setq output-is-fn t))
+ (t
+ (error "Progress-message expected nil or string, not a
%S" (type-of v))))
+ (setq progress-message v))
+
+ (_ (error "Unknown argument %S" arg-current)))))
+ (t
+ (error
+ "Optional arguments must be keyword, value pairs, found %S = %S"
+ (type-of arg-current)
+ arg-current)))))
+
+ ;; Set defaults when unset.
+ (unless idle
+ (setq idle 0.01))
+
+ ;; TODO: detect.
+ (unless jobs
+ (setq jobs
+ (cond
+ ((fboundp 'num-processors) ;; Emacs 29+
+ (* 2 (num-processors)))
+ (t
+ (or diff-ansi-multiprocess-jobs 64)))))
+
+ (let*
+ (
+ (args-len (length args))
+ (results (make-vector args-len nil))
+ (procs (make-vector args-len nil))
+ (jobs-pending nil)
+ (count-complete 0)
+ (count-running 0)
+ (no-error t)
+
+ (output-funcall-next 0)
+
+ (filter-job-fn
+ (lambda (proc str)
+ (let ((id (process-get proc :my-job-id)))
+ (aset results id (cons str (aref results id))))))
+
+ (sentinel-job-fn
+ (lambda (proc _msg)
+ (let ((id (process-get proc :my-job-id)))
+ ;; Clear the process in the array so it's never touched again.
+ (aset procs id nil)
+ (let ((exit-code (process-exit-status proc)))
+ (unless (zerop exit-code)
+ (setq no-error nil)
+ (error "Command exited code=%d: %S" exit-code (aref args
id))))
+
+ (delete-process proc)
+
+ (setq count-complete (1+ count-complete))
+ (setq count-running (1- count-running))
+ (when output
+ (let ((str (mapconcat #'identity (reverse (aref results id))
"")))
+ (aset results id str)))
+
+ (when progress-message
+ (let ((message-log-max nil))
+ (message
+ "%s%.2f%%"
+ progress-message
+ (* 100.0 (/ (float count-complete) args-len))))))))
+
+ (start-job-fn
+ (lambda (i)
+ (setq count-running (1+ count-running))
+ (let
+ (
+ (proc
+ (make-process
+ :name (concat "call-process-parallel" (number-to-string i))
+ ;; Write to the intermediate buffer or the final output.
+ :connection-type 'pipe
+ :command (aref args i)
+ :filter filter-job-fn
+ :sentinel sentinel-job-fn)))
+
+ (process-put proc :my-job-id i)))))
+
+ ;; Convert `args' to a vector for fast indexing.
+ (setq args (vconcat args))
+
+ ;; Setup indices to represent jobs that aren't complete.
+ (let ((i args-len))
+ (while (not (zerop i))
+ (push (setq i (1- i)) jobs-pending)))
+
+ ;; Main loop to complete
+ (diff-ansi--with-temp-echo-area
+ (while
+ (progn
+ ;; Run every time, important to run before exiting.
+ (when output-is-fn
+ (let
+ (
+ (str nil)
+ (is-modified nil))
+ (while
+ (and
+ (< output-funcall-next args-len)
+ (stringp (setq str (aref results output-funcall-next))))
+ ;; Overwrite with `t' (never to use again).
+ (funcall output output-funcall-next str)
+ (aset results output-funcall-next t)
+ (setq output-funcall-next (1+ output-funcall-next))
+ (setq is-modified t))
+ (when is-modified
+
+ (redisplay))))
+
+ ;; Check if exiting is needed.
+ (and no-error (not (eq count-complete args-len))))
+
+ ;; Fill the queue.
+ (while (and jobs-pending (< count-running jobs))
+ (funcall start-job-fn (pop jobs-pending)))
+
+ (sleep-for idle)))
+
+ (unless no-error
+ (dotimes (i args-len)
+ (let ((proc (aref procs i)))
+ (when proc
+ (delete-process proc)))))
+
+ (cond
+ ((eq output t)
+ results)
+ (t
+ nil)))))
+
+(defun diff-ansi--face-attr-to-hex-literal (face attr)
+ "Return the HEX color from FACE and ATTR."
+ (apply #'format
+ (cons
+ "#%02x%02x%02x"
+ (mapcar
+ ;; Shift by -8 to map the value returned by `color values':
+ ;; 0..65535 to 0..255 for `#RRGGBB` string formatting.
+ (lambda (n) (ash n -8)) (color-values (face-attribute face attr))))))
+
+
+;; ---------------------------------------------------------------------------
+;; Diff/ANSI Wrapper
+
+(defun diff-ansi--ansi-color-apply-on-region-with-bg (beg end)
+ "Wrapper function for `ansi-color-apply-on-region', applying color in (BEG
END)."
+ (setq diff-ansi--ansi-color-bg
+ (list
+ :background (diff-ansi--face-attr-to-hex-literal 'diff-ansi-default-face
:background)
+ :extend t))
+ (diff-ansi--ansi-color-apply-on-region-with-bg-impl beg end))
+
+(defun diff-ansi--ansi-color-apply-on-region-with-bg-str (black-color)
+ "Create string that can be passed to a sub-process using BLACK-COLOR."
+ (format
+ "(progn %s %s %s %s %s)"
+ "(require 'ansi-color)"
+ (format "(defconst diff-ansi--ansi-color-bg (list :background \"%s\"
:extend t))" black-color)
+ diff-ansi--code-block-for-multiprocess-defs
+ "(diff-ansi--ansi-color-apply-on-region-with-bg-impl (point-min)
(point-max))"
+ "(prin1 (buffer-substring (point-min) (point-max))
#'external-debugging-output)"))
+
+
+;; ---------------------------------------------------------------------------
+;; Diff Implementations
+
+(defun diff-ansi--command-preset-impl ()
+ "Return the command to run delta."
+ (pcase diff-ansi-tool
+ ('delta
+ (append
+ (list
+ "delta"
+ (format "--width=%d" (window-body-width (get-buffer-window
(current-buffer)))))
+ diff-ansi-extra-args-for-delta))
+ ('diff-so-fancy (append (list "diff-so-fancy")
diff-ansi-extra-args-for-diff-so-fancy))
+ ('ydiff
+ (append
+ (list
+ "ydiff"
+ "--color=always"
+ (format "--width=%d" (/ (window-body-width (get-buffer-window
(current-buffer)) 2))))
+ diff-ansi-extra-args-for-ydiff))
+ ('custom diff-ansi-tool-custom)
+ (_ (error "Unknown tool %S" diff-ansi-tool))))
+
+
+;; ---------------------------------------------------------------------------
+;; ANSI Conversion (Immediate)
+
+(defun diff-ansi--immediate-impl (beg end &optional target-buf)
+ "Colorize the text between BEG and END immediately.
+Store the result in TARGET-BUF when non-nil."
+ (let
+ (
+ (diff-command (diff-ansi--command-preset-impl))
+ (diff-str (buffer-substring-no-properties beg end)))
+
+ (unless target-buf
+ (delete-region beg end)
+ (goto-char beg))
+
+ (with-current-buffer (or target-buf (current-buffer))
+ (let ((inhibit-read-only t))
+ (setq beg (point))
+ (diff-ansi--call-process-pipe-chain diff-command :input diff-str
:output (current-buffer))
+ (setq end (point))
+
+ (diff-ansi--ansi-color-apply-on-region-with-bg beg (point))))))
+
+
+;; ---------------------------------------------------------------------------
+;; ANSI Conversion (Progressive)
+
+(defun diff-ansi-progressive-highlight-impl (buf range)
+ "Callback to update colors for BUF in RANGE."
+ (unless (input-pending-p)
+ (with-current-buffer buf
+ (let*
+ (
+ (do-redisplay nil)
+ (inhibit-read-only t)
+ (end (cdr range))
+ (end-trailing-chars (- (buffer-size) end))
+ (disp-beg (car range))
+ (disp-end
+ (min
+ end ;; Clamp twice because `line-end-position' could exceed the
value.
+ (save-excursion
+ (goto-char (min (+ disp-beg diff-ansi-chunks-size) end))
+ (line-end-position)))))
+ (save-excursion
+ (cond
+ ((eq disp-beg disp-end)
+ (cancel-timer diff-ansi--ansi-color-timer)
+ (setq diff-ansi--ansi-color-timer nil))
+ (t
+ (let ((disp-end-mark (set-marker (make-marker) disp-end)))
+ (diff-ansi--ansi-color-apply-on-region-with-bg disp-beg
disp-end)
+
+ (setq do-redisplay t)
+ ;; Update the display start and actual end.
+ (setcar range (marker-position disp-end-mark))
+ (setcdr range (- (buffer-size) end-trailing-chars))))))
+
+ ;; Re-display outside the block that moves the cursor.
+ (when do-redisplay
+ (redisplay))))))
+
+(defun diff-ansi--progressive-impl (beg end &optional target-buf)
+ "Colorize the text between BEG and END using a timer.
+Store the result in TARGET-BUF when non-nil."
+ (when diff-ansi--ansi-color-timer
+ (cancel-timer diff-ansi--ansi-color-timer)
+ (setq diff-ansi--ansi-color-timer nil))
+ (let
+ (
+ (diff-command (diff-ansi--command-preset-impl))
+ (diff-str (buffer-substring-no-properties beg end)))
+
+ (unless target-buf
+ (delete-region beg end)
+ (goto-char beg))
+
+ (with-current-buffer (or target-buf (current-buffer))
+ (let ((inhibit-read-only t))
+ (setq beg (point))
+ (diff-ansi--call-process-pipe-chain diff-command :input diff-str
:output (current-buffer))
+ (setq end (point))
+
+ (setq diff-ansi--ansi-color-timer
+ (run-at-time
+ 0.0
+ 0.001
+ #'diff-ansi-progressive-highlight-impl
+ (current-buffer)
+ (cons beg end)))))))
+
+
+;; ---------------------------------------------------------------------------
+;; ANSI Conversion (Multi-Processing)
+
+(defun diff-ansi--multiprocess-impl (beg end &optional target-buf)
+ "Colorize the text between BEG and END using multiple processes.
+Store the result in TARGET-BUF when non-nil."
+ (let
+ (
+ (diff-command (diff-ansi--command-preset-impl))
+ (diff-str (buffer-substring-no-properties beg end))
+ (per-chunk-args nil))
+
+ (unless target-buf
+ (delete-region beg end)
+ (goto-char beg))
+
+ (with-current-buffer (or target-buf (current-buffer))
+ (let ((inhibit-read-only t))
+ (diff-ansi--with-temp-directory temp-dir
+ :prefix "diff-ansi"
+ (with-temp-buffer
+ ;; Use the temp buffer.
+ (diff-ansi--call-process-pipe-chain
+ diff-command
+ :input diff-str
+ :output (current-buffer))
+
+ (goto-char (point-min))
+ (let*
+ (
+ (black-color
+ (diff-ansi--face-attr-to-hex-literal 'diff-ansi-default-face
:background))
+ (emacs-bin (expand-file-name invocation-name
invocation-directory))
+ (emacs-eval-arg
(diff-ansi--ansi-color-apply-on-region-with-bg-str black-color))
+
+ (point-prev (point))
+ ;; Index (for unique names.
+ (i 0))
+ (while (not (eobp))
+ (setq point-prev (point))
+ (goto-char (min (+ (point) diff-ansi-chunks-size) (point-max)))
+ (end-of-line)
+
+ (let ((output (concat temp-dir (number-to-string i))))
+ (write-region point-prev (point) output nil 0)
+ (push (list emacs-bin "--batch" output "--eval"
emacs-eval-arg) per-chunk-args))
+ (setq i (1+ i)))
+
+ (setq per-chunk-args (reverse per-chunk-args))))
+
+ ;; Out of the temp buffer.
+ (setq beg (point))
+ (diff-ansi--call-process-parallel per-chunk-args
+ :output (lambda (_i str) (insert (read str)))
+ :progress-message "Diff progress: ")
+ (setq end (point)))))))
+
+
+;; ---------------------------------------------------------------------------
+;; Internal Logic
+
+;; Helper function (not public).
+(defun diff-ansi--magit-insert-revision-diff-advice-fn (old-fn &rest args)
+ "Internal function use to advise using `diff-ansi-advice-add'.
+
+This calls OLD-FN with ARGS."
+ (let ((point-begin (point)))
+ (diff-ansi--with-advice 'magit-wash-sequence
+ :override (lambda (&rest _) nil)
+
+ (apply old-fn args)
+
+ (with-demoted-errors "diff-ansi: %S"
+ ;; Don't do anything to the diff, it may cause problems.
+ (diff-ansi-region point-begin (point-max))))))
+
+(defun diff-ansi--enable ()
+ "Enable the buffer local minor mode."
+ (when diff-ansi-use-magit-revision-diff
+ (require 'magit-diff)
+ (advice-add 'magit-insert-revision-diff
+ :around #'diff-ansi--magit-insert-revision-diff-advice-fn)))
+
+(defun diff-ansi--disable ()
+ "Disable the buffer local minor mode."
+ (when diff-ansi-use-magit-revision-diff
+ (require 'magit-diff)
+ (advice-remove 'magit-insert-revision-diff
#'diff-ansi--magit-insert-revision-diff-advice-fn)))
+
+;; ---------------------------------------------------------------------------
+;; Public Functions
+
+;;;###autoload
+(defun diff-ansi-region (beg end &rest args)
+ "Convert the diff between points BEG and END into an ANSI-diff.
+
+Optional keywords in ARGS.
+
+:create-buffer
+ When t, create a new buffer for the diff contents and return it.
+ Note that the buffer is not made active.
+
+:preserve-point
+ When t, place the cursor at the relative line offset based on the location
+ in the original buffer (this uses a simple method that doesn't ensure
+ an exact match for the current line).
+
+Return the buffer used to write data into on success."
+
+
+ (let
+ ( ;; Keyword arguments.
+ (create-buffer nil)
+ (preserve-point nil)
+
+ ;; To update end after the buffer has been resized.
+ (end-trailing-chars (- (buffer-size) end))
+
+ ;; For `preserve-point'.
+ (lines-to-beg nil)
+ (lines-to-end nil)
+ ;; For `into-buffer'.
+ (target-buf nil))
+
+ ;; Handle keyword arguments.
+ (while args
+ (let ((arg-current (pop args)))
+ (cond
+ ((keywordp arg-current)
+ (unless args
+ (error "Keyword argument %S has no value!" arg-current))
+ (let ((v (pop args)))
+ (pcase arg-current
+ (:create-buffer
+ (cond
+ ((null v)) ;; No input.
+ ((eq v t)) ;; OK.
+ (t
+ (error "Expected `:create-buffer', to be nil or t")))
+ (setq create-buffer v))
+
+ (:preserve-point
+ (cond
+ ((null v)) ;; No input.
+ ((eq v t)) ;; OK.
+ (t
+ (error "Expected `:preserve-point', to be nil or t")))
+ (setq preserve-point v))
+ (_ (error "Unknown argument %S" arg-current)))))
+ (t
+ (error
+ "All arguments must be keyword, value pairs, found %S = %S"
+ (type-of arg-current)
+ arg-current)))))
+
+ (when preserve-point
+ (setq lines-to-beg (count-lines (point) beg))
+ (setq lines-to-end (count-lines (point) end)))
+
+ (when create-buffer
+ (setq target-buf (generate-new-buffer (concat (buffer-name) "
(ansi-diff)")))
+ (with-current-buffer target-buf
+ (setq buffer-read-only t)
+ (setq buffer-undo-list t)
+ ;; We don't have our own mode (is it even needed?).
+ ;; Just set text mode for basic navigation functionality.
+ (text-mode)
+ ;; Don't display fill column.
+ (setq-local fill-column nil)))
+
+ (let ((method diff-ansi-method))
+
+ ;; Fallback to immediate when the task wont be split.
+ (when (<= (- end beg) diff-ansi-chunks-size)
+ (setq method 'immediate))
+
+ (cond
+ ((eq method 'immediate)
+ (diff-ansi--immediate-impl beg end target-buf))
+ ((eq method 'progressive)
+ (diff-ansi--progressive-impl beg end target-buf))
+ ((eq method 'multiprocess)
+ (diff-ansi--multiprocess-impl beg end target-buf))
+ (t
+ (error "Unknown method: %S" method))))
+
+ ;; Update end.
+ (unless target-buf
+ (setq end (- (point-max) end-trailing-chars)))
+
+ ;; This is only an approximation, as the diff views may not be exactly
compatible.
+ (when preserve-point
+ (with-current-buffer (or target-buf (current-buffer))
+ (when target-buf
+ (setq beg (point-min))
+ (setq end (point-max)))
+ (cond
+ ((zerop lines-to-beg)
+ (goto-char beg))
+ ((zerop lines-to-end)
+ (goto-char end))
+ (t
+ ;; Match the relative vertical offset.
+ (let*
+ (
+ (lines-total-after (count-lines beg end))
+ (factor (/ (float lines-total-after) (float (+ lines-to-beg
lines-to-end)))))
+ (goto-char beg)
+ (forward-line (truncate (* lines-to-beg factor))))))))
+
+ (cond
+ (create-buffer
+ (set-buffer-modified-p nil)
+ target-buf)
+ (t
+ (current-buffer)))))
+
+;;;###autoload
+(defun diff-ansi-buffer ()
+ "Create an ANSI-diff buffer from the existing plain-diff buffer."
+ (interactive)
+ (let ((buf (diff-ansi-region (point-min) (point-max) :create-buffer t
:preserve-point t)))
+ (switch-to-buffer buf)))
+
+;;;###autoload
+(define-minor-mode diff-ansi-mode
+ "Enable `diff-ansi' integration."
+ :global nil
+ (cond
+ (diff-ansi-mode
+ (diff-ansi--enable))
+ (t
+ (diff-ansi--disable))))
+
+(provide 'diff-ansi)
+;;; diff-ansi.el ends here
diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000000..75273b7584
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,111 @@
+#########
+Diff ANSI
+#########
+
+Integrate external diff commands into Emacs for improved visualization.
+
+Available via `melpa <https://melpa.org/#/diff-ansi>`__.
+
+
+Motivation
+==========
+
+*This package aims to expose the best possible diff rendering, to save time
and improve reading diff's in Emacs!*
+
+When reading diff's, features such as side-by-side display, word-level changes
and syntax highlighting
+can help understanding the changes that have been made.
+
+3rd party tools are available that support these features - this package aims
to make those accessible within Emacs.
+
+.. figure::
https://gitlab.com/ideasman42/emacs-diff-ansi/uploads/0dc4a85d55627707c801b002a8fc6ab0/diff-ansi-screenshot.png
+ :scale: 50 %
+ :align: center
+
+ Screenshot of the ``diff-ansi`` used in Magit's log view.
+
+
+Usage
+=====
+
+Currently there are two main uses for this package.
+
+- You may run ``diff-ansi-buffer`` to display the current diff buffer.
+- Enable ``diff-ansi-mode`` minor mode which installs hooks to use enhanced
diff display for Magit's revision display.
+
+
+Commands
+--------
+
+``diff-ansi-buffer``
+ Create a new read-only buffer displaying diff contents from the current
buffer.
+
+``diff-ansi-mode``
+ Enable a minor mode to use ``diff-ansi`` functionality where possible.
+
+
+Customization
+-------------
+
+``diff-ansi-tool``: ``'delta``
+ The external tool to use for displaying diffs.
+
+ - `'delta <https://github.com/dandavison/delta>`__ supports side-by-side
view, word level differences and syntax highlighting.
+ - `'diff-so-fancy <https://github.com/so-fancy/diff-so-fancy>`__ supports
word level differences.
+ - `'ydiff <https://github.com/yinwang0/ydiff>`__ supports side-by-side view
& word level differences.
+ - ``'custom`` call a custom command using (``diff-ansi-tool-custom``).
+
+``diff-ansi-extra-args-for-delta``
+ Additional arguments to pass to delta.
+
+``diff-ansi-extra-args-for-ydiff``
+ Additional arguments to pass to delta.
+
+``diff-ansi-tool-custom``
+ The command to use when ``diff-ansi-tool`` is set to ``'custom``.
+
+``diff-ansi-use-magit-revision-diff``
+ Use ``diff-ansi`` when viewing commits in magit.
+
+``diff-ansi-default-face``
+ The background color of this face is used when no color is specified.
+
+Advanced Customization
+^^^^^^^^^^^^^^^^^^^^^^
+
+Note that in general these settings can be left as-is,
+but may be extended to adjust default behavior.
+
+``diff-ansi-method``: ``'multiprocess``
+ Method used for decoding ANSI sequences.
+
+ - ``'immediate`` to convert immediate (blocking may be slow).
+ - ``'progressive`` uses a timer (avoids blocking input).
+ - ``'multiprocess`` to span multiple external processes for improved
performance on large diffs.
+
+``diff-ansi-chunks-size``: 8192
+ The number of characters to process at a time for
+ when ``diff-ansi-method`` is set to ``progressive`` or ``multiprocess``.
+
+``diff-ansi-multiprocess-jobs``
+ The number of processes to run simultaneously
+ when ``diff-ansi-method`` is set to ``multiprocess``.
+
+
+Details
+=======
+
+- Converting ANSI escape sequences can be slow for large diffs,
+ this is why ``multiprocess`` support is default to avoid long wait times
viewing diffs.
+
+
+Installation
+============
+
+The package is available in melpa as ``diff-ansi``, here is an example with
``use-package``:
+
+The package can be installed using ``straight``.
+
+.. code-block:: elisp
+
+ (use-package diff-ansi
+ :commands (diff-ansi-mode diff-ansi-buffer)))
