From 76dabe2e474809f300def65113c4fe2566dd904e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20M=C3=BCnchbach?= <florian.muenchbach@gmail.com>
Date: Sat, 9 Feb 2019 20:36:11 +0100
Subject: [PATCH] [syntax_highlight] Port Syntax Highlighting Plugin
---
syntax_highlight/LICENSE | 674 ++++++++++++++++++++++++++
syntax_highlight/README.md | 100 ++++
syntax_highlight/__init__.py | 1 +
syntax_highlight/config_dialog.ui | 304 ++++++++++++
syntax_highlight/gtkformatter.py | 113 +++++
syntax_highlight/manifest.ini | 23 +
syntax_highlight/syntax_highlight.png | Bin 0 -> 465 bytes
syntax_highlight/syntax_highlight.py | 656 +++++++++++++++++++++++++
8 files changed, 1871 insertions(+)
create mode 100644 syntax_highlight/LICENSE
create mode 100644 syntax_highlight/README.md
create mode 100644 syntax_highlight/__init__.py
create mode 100644 syntax_highlight/config_dialog.ui
create mode 100644 syntax_highlight/gtkformatter.py
create mode 100644 syntax_highlight/manifest.ini
create mode 100644 syntax_highlight/syntax_highlight.png
create mode 100644 syntax_highlight/syntax_highlight.py
diff --git a/syntax_highlight/LICENSE b/syntax_highlight/LICENSE
new file mode 100644
index 00000000..9cecc1d4
--- /dev/null
+++ b/syntax_highlight/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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:
+
+ {project} Copyright (C) {year} {fullname}
+ 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
+<http://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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/syntax_highlight/README.md b/syntax_highlight/README.md
new file mode 100644
index 00000000..b09e712e
--- /dev/null
+++ b/syntax_highlight/README.md
@@ -0,0 +1,100 @@
+# Syntax Highlighting Plugin for Gajim
+
+[Gajim](https://gajim.org) Plugin that highlights source code blocks in chatbox.
+
+## Installation
+
+The recommended way of installing this plugin is to use
+Gajim's Plugin Installer.
+
+For more information and instruction on how to install plugins manually, please
+refer to the [Gajim Plugin Wiki seite](https://dev.gajim.org/gajim/gajim-plugins/wikis/home#how-to-install-plugins).
+
+
+## Usage
+
+This plugin uses markdown-style syntax to identify which parts of a message
+should be formatted as code in the chatbox.
+
+```
+Inline source code will be highlighted when placed in between `two single
+back-ticks`.
+```
+
+The language used to highlight the syntax of inline code is selected as the
+default language in the plugin settings.
+
+
+Multi-line code blocks are started by three back-ticks followed by a newline.
+Optionally, a language can be specified directly after the opening back-ticks and
+before the line break:
+````
+```language
+Note, that the last line of a code block may only contain the closing back-ticks,
+i.e. there must be a newline here.
+```
+````
+
+In case no languge is specified with the opening tag or the specified language
+could not be identified, the default languge configured in the settings is
+used.
+
+You can test it by copying and sending the following text to one of your
+contacts:
+````
+```python
+def test():
+ print("Hello, world!")
+```
+````
+(**Note:** your contact will not receive highlighted text unless she is also
+using the plugin.)
+
+## Configuration
+
+The configuration can be found via 'Gajim' > 'Plugins', then select the
+'Source Code Syntax Highlight' Plugin and click the gears symbol.
+The configuration options let you specify many details how code is formatted,
+including default language, style, font settings, background color and formatting
+of the code markers.
+
+In the configuration window, the current settings are displayed in an
+interactive preview pannel. This allows you to directly check how code would
+look like in the message
+window.
+
+## Report Bugs and Feature Requests
+
+For bug reports, please report them to the [Gajim Plugin Issue tracker](https://dev.gajim.org/gajim/gajim-plugins/issues/new?issue[FlorianMuenchbach]=&issue[description]=Gajim%20Version%3A%20%0APlugin%20Version%3A%0AOperating%20System%3A&issue[title]=[syntax_highlight]).
+
+Please make sure that the issue you create contains `[syntax_highlight]` in the
+title and information such as Gajim version, Plugin version, Operating system,
+etc.
+
+## Debug
+
+The plugin adds its own logger. It can be used to set a specific debug level
+for this plugin and/or filter log messages.
+
+Run
+```
+gajim --loglevel gajim.plugin_system.syntax_highlight=DEBUG
+```
+in a terminal to display the debug messages.
+
+
+## Known Issues / ToDo
+
+ * ~~Gajim crashes when correcting a message containing highlighted code.~~
+ (fixed in version 1.1.0)
+
+
+## Credits
+
+Since I had no experience in writing Plugins for Gajim, I used the
+[Latex Plugin](https://trac-plugins.gajim.org/wiki/LatexPlugin)
+written by Yves Fischer and Yann Leboulanger as an example and copied a big
+portion of initial code. Therefore, credits go to the authors of the Latex
+Plugin for providing an example.
+
+The syntax highlighting itself is done by [pygments](http://pygments.org/).
diff --git a/syntax_highlight/__init__.py b/syntax_highlight/__init__.py
new file mode 100644
index 00000000..f64af433
--- /dev/null
+++ b/syntax_highlight/__init__.py
@@ -0,0 +1 @@
+from .syntax_highlight import SyntaxHighlighterPlugin
diff --git a/syntax_highlight/config_dialog.ui b/syntax_highlight/config_dialog.ui
new file mode 100644
index 00000000..9a2014e8
--- /dev/null
+++ b/syntax_highlight/config_dialog.ui
@@ -0,0 +1,304 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated with glade 3.22.1 -->
+<interface>
+ <requires lib="gtk+" version="3.0"/>
+ <object class="GtkTextBuffer"/>
+ <object class="GtkListStore" id="code_marker_selection">
+ <columns>
+ <!-- column-name column1 -->
+ <column type="gchararray"/>
+ </columns>
+ <data>
+ <row>
+ <col id="0" translatable="yes">Treat as code comment</col>
+ </row>
+ <row>
+ <col id="0" translatable="yes">Hide code markers</col>
+ </row>
+ </data>
+ </object>
+ <object class="GtkListStore" id="line_break_selection">
+ <columns>
+ <!-- column-name Text -->
+ <column type="gchararray"/>
+ </columns>
+ <data>
+ <row>
+ <col id="0" translatable="yes">Never</col>
+ </row>
+ <row>
+ <col id="0" translatable="yes">Always</col>
+ </row>
+ <row>
+ <col id="0" translatable="yes">Only around multi-line code blocks</col>
+ </row>
+ </data>
+ </object>
+ <object class="GtkTextBuffer" id="preview_textbuffer">
+ <property name="text" translatable="yes">// Test your highlighting here
+# Test your highlighting here
+/* Test your highlighting here */
+% Test your highlighting here
+; Test your highlighting here
+<!-- Test your highlighting here --></property>
+ </object>
+ <object class="GtkWindow" id="window1">
+ <property name="can_focus">False</property>
+ <child>
+ <placeholder/>
+ </child>
+ <child>
+ <object class="GtkBox" id="mainBox">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="orientation">vertical</property>
+ <child>
+ <object class="GtkGrid">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="margin_bottom">40</property>
+ <child>
+ <object class="GtkLabel" id="label1">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="label" translatable="yes">Default Language for Syntax Highlighting</property>
+ <property name="xalign">0</property>
+ </object>
+ <packing>
+ <property name="left_attach">0</property>
+ <property name="top_attach">0</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkLabel" id="label2">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="label" translatable="yes">Insert Line breaks around Code Blocks</property>
+ <property name="xalign">0</property>
+ </object>
+ <packing>
+ <property name="left_attach">0</property>
+ <property name="top_attach">1</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkComboBox" id="default_lexer_combobox">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <signal name="changed" handler="lexer_changed" swapped="no"/>
+ <child>
+ <object class="GtkCellRendererText" id="cellrenderertext1"/>
+ <attributes>
+ <attribute name="text">0</attribute>
+ </attributes>
+ </child>
+ </object>
+ <packing>
+ <property name="left_attach">1</property>
+ <property name="top_attach">0</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkComboBox" id="line_break_combobox">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="model">line_break_selection</property>
+ <signal name="changed" handler="line_break_changed" swapped="no"/>
+ <child>
+ <object class="GtkCellRendererText" id="cellrenderertext2"/>
+ <attributes>
+ <attribute name="text">0</attribute>
+ </attributes>
+ </child>
+ </object>
+ <packing>
+ <property name="left_attach">1</property>
+ <property name="top_attach">1</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkComboBox" id="style_combobox">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <signal name="changed" handler="style_changed" swapped="no"/>
+ <child>
+ <object class="GtkCellRendererText" id="cellrenderertext3"/>
+ <attributes>
+ <attribute name="text">0</attribute>
+ </attributes>
+ </child>
+ </object>
+ <packing>
+ <property name="left_attach">1</property>
+ <property name="top_attach">2</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkLabel" id="label3">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="label" translatable="yes">Select Syntax Highlighting Style</property>
+ <property name="xalign">0</property>
+ </object>
+ <packing>
+ <property name="left_attach">0</property>
+ <property name="top_attach">2</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkLabel">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="label" translatable="yes">Select code marker (the backticks) formatting:</property>
+ <property name="xalign">0</property>
+ </object>
+ <packing>
+ <property name="left_attach">0</property>
+ <property name="top_attach">3</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkComboBox" id="code_marker_combobox">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="model">code_marker_selection</property>
+ <signal name="changed" handler="code_marker_changed" swapped="no"/>
+ <child>
+ <object class="GtkCellRendererText" id="cellrenderertext4"/>
+ <attributes>
+ <attribute name="text">0</attribute>
+ </attributes>
+ </child>
+ </object>
+ <packing>
+ <property name="left_attach">1</property>
+ <property name="top_attach">3</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkLabel">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="label" translatable="yes">Select Font for Code Snippets:</property>
+ <property name="xalign">0</property>
+ </object>
+ <packing>
+ <property name="left_attach">0</property>
+ <property name="top_attach">4</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkFontButton" id="font_button">
+ <property name="visible">True</property>
+ <property name="can_focus">True</property>
+ <property name="receives_default">True</property>
+ <property name="font">Sans 12</property>
+ <property name="language">de-de</property>
+ <property name="preview_text"/>
+ <property name="use_font">True</property>
+ <signal name="font-set" handler="font_changed" swapped="no"/>
+ </object>
+ <packing>
+ <property name="left_attach">1</property>
+ <property name="top_attach">4</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkCheckButton" id="bg_color_checkbutton">
+ <property name="label" translatable="yes">Set Background Color</property>
+ <property name="visible">True</property>
+ <property name="can_focus">True</property>
+ <property name="receives_default">False</property>
+ <property name="halign">start</property>
+ <property name="draw_indicator">True</property>
+ <signal name="toggled" handler="bg_color_enabled" swapped="no"/>
+ </object>
+ <packing>
+ <property name="left_attach">0</property>
+ <property name="top_attach">5</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkColorButton" id="bg_color_colorbutton">
+ <property name="visible">True</property>
+ <property name="can_focus">True</property>
+ <property name="receives_default">True</property>
+ <property name="halign">center</property>
+ <property name="valign">center</property>
+ <property name="title" translatable="yes">Chose the background color for code blocks</property>
+ <property name="show_editor">True</property>
+ <signal name="color-set" handler="bg_color_changed" swapped="no"/>
+ </object>
+ <packing>
+ <property name="left_attach">1</property>
+ <property name="top_attach">5</property>
+ </packing>
+ </child>
+ </object>
+ <packing>
+ <property name="expand">False</property>
+ <property name="fill">False</property>
+ <property name="position">0</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkSeparator">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ </object>
+ <packing>
+ <property name="expand">False</property>
+ <property name="fill">True</property>
+ <property name="position">1</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkLabel">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="margin_top">20</property>
+ <property name="margin_bottom">5</property>
+ <property name="label" translatable="yes">Test how code blocks will look like in the chat window:</property>
+ <property name="xalign">0</property>
+ </object>
+ <packing>
+ <property name="expand">False</property>
+ <property name="fill">True</property>
+ <property name="position">2</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkTextView" id="preview_textview">
+ <property name="visible">True</property>
+ <property name="can_focus">True</property>
+ <property name="wrap_mode">word-char</property>
+ <property name="buffer">preview_textbuffer</property>
+ </object>
+ <packing>
+ <property name="expand">True</property>
+ <property name="fill">True</property>
+ <property name="position">3</property>
+ </packing>
+ </child>
+ <child>
+ <object class="GtkSeparator">
+ <property name="visible">True</property>
+ <property name="can_focus">False</property>
+ <property name="margin_top">20</property>
+ </object>
+ <packing>
+ <property name="expand">False</property>
+ <property name="fill">True</property>
+ <property name="position">4</property>
+ </packing>
+ </child>
+ <child>
+ <placeholder/>
+ </child>
+ </object>
+ </child>
+ </object>
+ <object class="GtkTextBuffer" id="textbuffer1">
+ <property name="text">Plug-in decription should be displayed here. This text will be erased during PluginsWindow initialization.</property>
+ </object>
+</interface>
diff --git a/syntax_highlight/gtkformatter.py b/syntax_highlight/gtkformatter.py
new file mode 100644
index 00000000..68c4afc5
--- /dev/null
+++ b/syntax_highlight/gtkformatter.py
@@ -0,0 +1,113 @@
+import logging
+
+from gi.repository import Gtk as gtk
+from gi.repository import Pango
+
+from pygments.formatter import Formatter
+from gajim.plugins.helpers import log
+log = logging.getLogger('gajim.plugin_system.syntax_highlight')
+
+class GTKFormatter(Formatter):
+ name = 'GTK Formatter'
+ aliases = ['textbuffer', 'gtk']
+ filenames = []
+
+ def __init__(self, **options):
+ super(GTKFormatter, self).__init__(**options)
+ #Formatter.__init__(self, **options)
+ self.tags = {}
+ self.mark = options.get('start_mark', None)
+
+ @staticmethod
+ def create_tag_for_token(ttype, highlighting_style):
+ style = highlighting_style.style_for_token(ttype)
+ tag = gtk.TextTag.new()
+ if 'bgcolor' in style and not style['bgcolor'] is None:
+ tag.set_property('background', '#%s' % style['bgcolor'])
+ if 'bold' in style and style['bold']:
+ tag.set_property('weight', Pango.Weight.BOLD)
+ if 'border' in style and not style['border'] is None:
+ pass
+ if 'color' in style and not style['color'] is None:
+ tag.set_property('foreground', '#%s' % style['color'])
+ if 'italic' in style and style['italic']:
+ tag.set_property('style', Pango.Style.ITALIC)
+ if 'mono' in style and not style['mono'] is None:
+ tag.set_property('family', 'Monospace')
+ tag.set_property('family-set', True)
+ if 'roman' in style and not style['roman'] is None:
+ pass
+ if 'sans' in style and not style['sans'] is None:
+ tag.set_property('family', 'Sans')
+ tag.set_property('family-set', True)
+ if 'underline' in style and style['underline']:
+ tag.set_property('underline', 'single')
+ return tag
+
+
+ def get_tag(self, ttype, buf):
+ """
+ Creates, stores and returs a tag for a given token type.
+
+ This method ensures that a tag style is created only once.
+ Furthermore, the tag will be added to the given Gtk.TextBuffer's tag table.
+ """
+ tag = None
+ if ttype in self.tags:
+ tag = self.tags[ttype]
+ else:
+ tag = GTKFormatter.create_tag_for_token(ttype, self.style)
+ self.tags[ttype] = tag
+ buf.get_tag_table().add(tag)
+ return tag
+
+ def set_insert_pos_mark(self, mark):
+ self.mark = mark
+
+ def format(self, tokensource, outfile):
+ if not isinstance(outfile, gtk.TextBuffer) or outfile is None:
+ log.warn("Did not get a buffer to format...")
+ return
+ buf = outfile
+
+ end_iter = buf.get_end_iter()
+
+ start_mark = self.mark
+ start_iter = buf.get_iter_at_mark(start_mark) if not start_mark is None \
+ else end_iter
+
+ last_ttype = None
+ last_start = start_iter
+ last_end = buf.get_end_iter()
+ last_fixed_start = last_start
+
+ reset = True
+
+ for ttype, value in tokensource:
+ search = None
+ if last_ttype is not None and ttype != last_ttype:
+ tag = self.get_tag(last_ttype, buf)
+
+ buf.apply_tag(tag, last_fixed_start, last_end)
+
+ search = last_end.forward_search(value, gtk.TextSearchFlags.TEXT_ONLY, end_iter)
+ reset = True
+ else:
+ # in case last_ttype is None, i.e. first loop walkthrough:
+ # last_start to end_iter is the full code block.
+ search = last_start.forward_search(value, gtk.TextSearchFlags.TEXT_ONLY, end_iter)
+
+ # Prepare for next iteration
+ last_ttype = ttype
+ if search is not None:
+ (last_start, last_end) = search
+
+ # If we've found the end of a sequence of similar type tokens or if
+ # we are in the first loop iteration, set the fixed point
+ if reset:
+ last_fixed_start = last_start
+ reset = False
+ else:
+ # Hm... Nothing found, but tags left? Seams there's nothing we
+ # can do now.
+ break
diff --git a/syntax_highlight/manifest.ini b/syntax_highlight/manifest.ini
new file mode 100644
index 00000000..e7231315
--- /dev/null
+++ b/syntax_highlight/manifest.ini
@@ -0,0 +1,23 @@
+[info]
+# Don't forget to point to the correct README.md file when switching to another
+# branch or so...
+name: Source Code Syntax Highlight
+short_name: syntax_highlight
+version: 1.1.0
+description: Source Code Syntax Highlighting in the chatbox.
+
+ It uses markdown-style syntax, i.e. text in between `single backticks` is
+ rendered as inline code, ```language
+ selection is possible in multi-line code snippets in between triple-backticks
+ Note the newlines in this case...
+ ```
+
+ *Note:* You need to have pygments installed.
+ Please refer to the plugin's Wiki page for more information.
+
+ Changing settings will take effect after closing and opening the message
+ tab/window again.
+authors = Florian Muenchbach
+homepage = https://dev.gajim.org/gajim/gajim-plugins/blob/gajim_1.1/syntax_highlight/README.md
+min_gajim_version: 1.1.0
+max_gajim_version: 1.1.90
diff --git a/syntax_highlight/syntax_highlight.png b/syntax_highlight/syntax_highlight.png
new file mode 100644
index 0000000000000000000000000000000000000000..76796c2809f4852111222bd348bb01b02cc44f21
GIT binary patch
literal 465
zcmV;?0WSWDP)<h;3K|Lk000e1NJLTq000mG000mO1^@s6AM^iV00004b3#c}2nYxW
zd<bNS00009a7bBm000D?000D?0em!Tp#T5?8FWQhbW?9;ba!ELWdL_~cP?peYja~^
zaAhuUa%Y?FJQ@H10ZvIoK~y-6wUV(*0$~`&e`j&v7R_lxv)~X7!V$PdLoU%$q=OVT
zxCSk5Mbk~uWDx~T3HBef)s(q7<e>jRwMZxB)8J>`T^bVfOn2||d!O(9UOxDDi33D+
zoE`beGZiX1z}pxv7@+?DafnF(b@T0x3h@UV37WpbEJBDC<2MC|<C?Pq2^zlQvI&?o
zOv5nQKy#azBk%<8g0wGS5AlMqOhDQ&UYnTn&24jDxnQd&SPzYLint3+x^~URXO8j>
zm?eHN9m#QK?Q*&lx>*8v@)ru6EN*fc>0%F;S;WoTc#6_d5w~EDvds89KCTd@BO6ae
z+<f4u9OW`d3p{%!VBRb+HDLOl)MrO1L**e(t7`&Q5k17rz>m}FW~kizdjbzBNiCJ+
zaqwsoKpTtK;X>+-BsGWMRH9^?39b;gBfW_vs)+r`8~&&-U%-epkf$nT00000NkvXX
Hu0mjfgD1V}
literal 0
HcmV?d00001
diff --git a/syntax_highlight/syntax_highlight.py b/syntax_highlight/syntax_highlight.py
new file mode 100644
index 00000000..2686337b
--- /dev/null
+++ b/syntax_highlight/syntax_highlight.py
@@ -0,0 +1,656 @@
+import logging
+import re
+from enum import Enum, IntEnum, unique
+
+from gi.repository import Gtk, Gdk
+from gi.repository.Gtk import TextSearchFlags
+from gi.repository.Pango import FontDescription
+
+from gajim.plugins.helpers import log_calls, log
+from gajim.plugins import GajimPlugin
+from gajim.plugins.gui import GajimPluginConfigDialog
+
+
+class MatchType(Enum):
+ INLINE = 0
+ MULTILINE = 1
+ TEXT = 2
+
+@unique
+class LineBreakOptions(IntEnum):
+ NEVER = 0
+ ALWAYS = 1
+ MULTILINE = 2
+
+@unique
+class CodeMarkerOptions(IntEnum):
+ AS_COMMENT = 0
+ HIDE = 1
+
+PYGMENTS_MISSING = 'You are missing Python-Pygments.'
+ERROR_MSG = ''
+
+log = logging.getLogger('gajim.plugin_system.syntax_highlight')
+DEFAULT_LEXER = "python"
+
+# Only on multi-line code blocks:
+DEFAULT_LINE_BREAK = LineBreakOptions.MULTILINE
+
+DEFAULT_STYLE = "default"
+
+DEFAULT_FONT = "Monospace 10"
+
+DEFAULT_BGCOLOR = "#ccc"
+DEFAULT_OVERRIDE_BGCOLOR = False
+
+DEFAULT_CODE_MARKER_SETTING = CodeMarkerOptions.AS_COMMENT
+
+try:
+ import pygments
+ from pygments.lexers import get_lexer_by_name, get_all_lexers
+ from pygments.styles import get_all_styles
+ from .gtkformatter import GTKFormatter
+except Exception as exception:
+ log.error("Import Error: %s.", exception)
+ ERROR_MSG = PYGMENTS_MISSING
+
+
+class SyntaxHighlighterPluginConfiguration(GajimPluginConfigDialog):
+ @log_calls('SyntaxHighlighterPluginConfiguration')
+ def init(self):
+ self.GTK_BUILDER_FILE_PATH = self.plugin.local_file_path(
+ 'config_dialog.ui')
+ self.xml = Gtk.Builder()
+ self.xml.set_translation_domain('gajim_plugins')
+ self.xml.add_objects_from_file(self.GTK_BUILDER_FILE_PATH,
+ ['mainBox', 'line_break_selection', 'code_marker_selection',
+ 'preview_textbuffer'])
+ box = self.xml.get_object('mainBox')
+ self.get_child().pack_start(box, False, False, 0)
+ self.result_label = self.xml.get_object('result_label')
+
+ self.liststore = Gtk.ListStore(str)
+
+ self.default_lexer_combobox = self.xml.get_object('default_lexer_combobox')
+ self.default_lexer_combobox.set_property("model", self.liststore)
+
+ self.style_liststore = Gtk.ListStore(str)
+ self.style_combobox = self.xml.get_object('style_combobox')
+ self.style_combobox.set_property("model", self.style_liststore)
+
+ self.bg_color_checkbox = self.xml.get_object('bg_color_checkbutton')
+ self.bg_color_colorbutton = self.xml.get_object('bg_color_colorbutton')
+
+ self.line_break_combobox = self.xml.get_object('line_break_combobox')
+
+ self.code_marker_combobox = self.xml.get_object('code_marker_combobox')
+
+ self.preview_textview = self.xml.get_object('preview_textview')
+ self.preview_textview.get_buffer().connect("insert-text", self.on_preview_text_inserted)
+ self.preview_textview.set_size_request(-1, 130)
+
+ self.font_button = self.xml.get_object('font_button')
+
+ self.xml.connect_signals(self)
+ self.default_lexer_id = 0
+ self.style_id = 0
+
+ def set_config(self, config):
+ self.config = config
+ self.lexers = self.config.get_lexer_list()
+ self.styles = self.config.get_styles_list()
+ default_lexer = self.config.get_default_lexer_name()
+ default_style = self.config.get_style_name()
+
+ for i, lexer in enumerate(self.lexers):
+ self.liststore.append([lexer[0]])
+ if lexer[1] == default_lexer:
+ self.default_lexer_id = i
+
+ for i, style in enumerate(self.styles):
+ self.style_liststore.append([style])
+ if style == default_style:
+ self.style_id = i
+ self.update_preview()
+
+ def lexer_changed(self, _widget):
+ new = self.default_lexer_combobox.get_active()
+ if new != self.default_lexer_id:
+ self.default_lexer_id = new
+ self.config.set_default_lexer(self.lexers[self.default_lexer_id][1])
+ self.update_preview()
+
+ def line_break_changed(self, _widget):
+ new = LineBreakOptions(self.line_break_combobox.get_active())
+ if new != self.config.get_line_break_action():
+ self.config.set_line_break_action(new)
+ self.update_preview()
+
+ def code_marker_changed(self, _widget):
+ new = CodeMarkerOptions(self.code_marker_combobox.get_active())
+ if new != self.config.get_code_marker_setting():
+ self.config.set_code_marker_setting(new)
+
+ def bg_color_enabled(self, _widget):
+ new = self.bg_color_checkbox.get_active()
+ if new != self.config.is_bgcolor_override_enabled():
+ bg_override_enabled = new
+ self.config.set_bgcolor_override_enabled(bg_override_enabled)
+ self.bg_color_colorbutton.set_sensitive(bg_override_enabled)
+ self.update_preview()
+
+ def bg_color_changed(self, _widget):
+ new = self.bg_color_colorbutton.get_color()
+ if new != self.config.get_bgcolor():
+ self.config.set_bgcolor(new)
+ self.update_preview()
+
+ def style_changed(self, _widget):
+ new = self.style_combobox.get_active()
+ if new != self.style_id:
+ self.style_id = new
+ self.config.set_style(self.styles[self.style_id])
+ self.update_preview()
+
+ def font_changed(self, _widget):
+ new = self.font_button.get_font()
+ if new != self.config.get_font():
+ self.config.set_font(new)
+ self.update_preview()
+
+ def update_preview(self):
+ self.format_preview_text()
+
+ def on_preview_text_inserted(self, _buf, _iterator, text, length, *_args):
+ if (length == 1 and re.match(r'\s', text)) or length > 1:
+ self.format_preview_text()
+
+ def format_preview_text(self):
+ buf = self.preview_textview.get_buffer()
+ start_iter = buf.get_start_iter()
+ start_mark = buf.create_mark(None, start_iter, True)
+ buf.remove_all_tags(start_iter, buf.get_end_iter())
+
+ formatter = GTKFormatter(
+ style=self.config.get_style_name(),
+ start_mark=start_mark)
+
+ code = start_iter.get_text(buf.get_end_iter())
+ lexer = self.config.get_default_lexer()
+ tokens = pygments.lex(code, lexer)
+
+ pygments.format(tokens, formatter, buf)
+
+ buf.delete_mark(start_mark)
+
+ self.preview_textview.override_font(
+ FontDescription.from_string(self.config.get_font()))
+
+ color = Gdk.RGBA()
+ if color.parse(self.config.get_bgcolor()):
+ self.preview_textview.override_background_color(
+ Gtk.StateFlags.NORMAL, color)
+
+ def on_run(self):
+ self.default_lexer_combobox.set_active(self.default_lexer_id)
+ self.line_break_combobox.set_active(self.config.get_line_break_action())
+ self.code_marker_combobox.set_active(self.config.get_code_marker_setting())
+ self.style_combobox.set_active(self.style_id)
+
+ self.font_button.set_font(self.config.get_font())
+
+ bg_override_enabled = self.config.is_bgcolor_override_enabled()
+ self.bg_color_checkbox.set_active(bg_override_enabled)
+
+ self.bg_color_colorbutton.set_sensitive(bg_override_enabled)
+
+ parsed, color = Gdk.Color.parse(self.config.get_bgcolor())
+ if parsed:
+ self.bg_color_colorbutton.set_color(color)
+
+
+
+class ChatSyntaxHighlighter:
+ def hide_code_markup(self, buf, start, end):
+ tag = buf.get_tag_table().lookup('hide_code_markup')
+ if tag is None:
+ tag = Gtk.TextTag.new('hide_code_markup')
+ tag.set_property('invisible', True)
+ buf.get_tag_table().add(tag)
+
+ buf.apply_tag_by_name('hide_code_markup', start, end)
+
+ def check_line_break(self, is_multiline):
+ line_break = self.config.get_line_break_action()
+
+ return (line_break == LineBreakOptions.ALWAYS) \
+ or (is_multiline and line_break == LineBreakOptions.MULTILINE)
+
+
+ def format_code(self, buf, s_tag, s_code, e_tag, e_code, language):
+ style = self.config.get_style_name()
+ if self.config.get_code_marker_setting() == CodeMarkerOptions.HIDE:
+ self.hide_code_markup(buf, s_tag, s_code)
+ self.hide_code_markup(buf, e_code, e_tag)
+ else:
+ comment_tag = GTKFormatter.create_tag_for_token(
+ pygments.token.Comment,
+ pygments.styles.get_style_by_name(style))
+ buf.get_tag_table().add(comment_tag)
+ buf.apply_tag(comment_tag, s_tag, s_code)
+ buf.apply_tag(comment_tag, e_tag, e_code)
+
+ code = s_code.get_text(e_code)
+ log.debug("full text to encode: %s.", code)
+
+
+ start_mark = buf.create_mark(None, s_code, False)
+
+ lexer = None
+
+ if language is None:
+ lexer = self.config.get_default_lexer()
+ log.info("No Language specified. Falling back to default lexer: %s.",
+ self.config.get_default_lexer_name())
+ else:
+ log.debug("Using lexer for %s.", str(language))
+ lexer = self.config.get_lexer_with_fallback(language)
+
+ if lexer is None:
+ iterator = buf.get_iter_at_mark(start_mark)
+ buf.insert(iterator, '\n')
+ else:
+ tokens = pygments.lex(code, lexer)
+
+ formatter = GTKFormatter(style=style, start_mark=start_mark)
+ pygments.format(tokens, formatter, buf)
+
+ def find_multiline_matches(self, text):
+ start = None
+ matches = []
+ for i in re.finditer(r'\n?```(?:\S*\n)?', text, re.DOTALL):
+ if start is None:
+ start = i
+ elif re.match(r'^\n```', i.group(0)) is not None:
+ matches.append(
+ (start.start(), i.end(), text[start.start():i.end()]))
+ start = None
+ else:
+ # not an end...
+ continue
+ return matches
+
+ def find_inline_matches(self, text):
+ return [(i.start(), i.end(), i.group(0)) for i in \
+ re.finditer(r'(?<!`)`(?!`|\n).+(?<!`)`', text)]
+
+ def merge_match_groups(self, real_text, inline_matches, multiline_matches):
+ it_inline = iter(inline_matches)
+ it_multi = iter(multiline_matches)
+ length = len(real_text)
+
+ # Just to get cleaner code below...
+ def get_next(iterator):
+ return next(iterator, (length, length, ""))
+
+ # In order to simplify the process, we use the 'length' here.
+ cur_inline = get_next(it_inline)
+ cur_multi = get_next(it_multi)
+
+ pos = 0
+
+ # This will contain tuples with parts of the input and its classification
+ parts = []
+ while pos < length:
+ log.debug("-> in: %s", str(cur_inline))
+ log.debug("-> mu: %s", str(cur_multi))
+
+ # selected = (start, end, type)
+ selected = (cur_inline[0], cur_inline[1], MatchType.INLINE) \
+ if cur_inline[0] < cur_multi[0] \
+ else (cur_multi[0], cur_multi[1], MatchType.MULTILINE) \
+ if cur_multi[0] < length \
+ else (pos, length, MatchType.TEXT)
+ log.debug("--> select: %s", str(selected))
+
+ # Handle plain text string parts (and unforseen errors...)
+ if pos < selected[0]:
+ end = selected[0] if selected[0] != pos else selected[1]
+ parts.append((real_text[pos:end], MatchType.TEXT))
+ pos = selected[0]
+ elif pos > selected[0]:
+ log.error("Should not happen, position > found match.")
+
+ # Cut out and append selected text segment
+ parts.append((real_text[selected[0]:selected[1]], selected[2]))
+ pos = selected[1]
+
+ # Depending on the match type, we have to forward the iterators.
+ # Also, forward the other one, if regions overlap or we took over...
+ if selected[2] == MatchType.INLINE:
+ if cur_multi[0] < cur_inline[1]:
+ cur_multi = get_next(it_multi)
+ cur_inline = get_next(it_inline)
+ elif selected[2] == MatchType.MULTILINE:
+ if cur_inline[0] < cur_multi[1]:
+ cur_inline = get_next(it_inline)
+ cur_multi = get_next(it_multi)
+
+ return parts
+
+ def process_text(self, real_text, other_tags, _graphics, iter_,
+ _additional):
+ def fix_newline(char, marker_len_no_newline, force=False):
+ fixed = (marker_len_no_newline, '')
+ if char == '\n':
+ fixed = (marker_len_no_newline + 1, '')
+ elif force:
+ fixed = (marker_len_no_newline + 1, '\n')
+ return fixed
+
+
+ buf = self.textview.tv.get_buffer()
+
+ # first, try to find inline or multiline code snippets
+ inline_matches = self.find_inline_matches(real_text)
+ multiline_matches = self.find_multiline_matches(real_text)
+
+ if not inline_matches and not multiline_matches:
+ log.debug("Stopping early, since there is no code block in it....")
+ return
+
+ iterator = iter_ if iter_ is not None else buf.get_end_iter()
+
+ # Create a start marker with left gravity before inserting text.
+ start_mark = buf.create_mark("SHP_start", iterator, True)
+ end_mark = buf.create_mark("SHP_end", iterator, False)
+
+ insert_newline_for_multiline = self.check_line_break(True)
+ insert_newline_for_inline = self.check_line_break(False)
+
+ split_text = self.merge_match_groups(
+ real_text, inline_matches, multiline_matches)
+
+ buf.begin_user_action()
+
+ for num, (text_to_insert, match_type) in enumerate(split_text):
+ marker = [("", 0), ("", 0)]
+ language = None
+ end_of_message = num == (len(split_text) - 1)
+
+ if match_type == MatchType.TEXT:
+ self.textview.detect_and_print_special_text(
+ text_to_insert, other_tags, graphics=_graphics,
+ iter_=iterator, additional_data=_additional)
+ else:
+ if match_type == MatchType.MULTILINE:
+ language_match = re.search(
+ '\n*```([^\n]*)\n', text_to_insert, re.DOTALL)
+ language = None if language_match is None \
+ else language_match.group(1)
+ language_len = 0 if language is None else len(language)
+
+ # We account the language word width for the front marker
+ front = fix_newline(text_to_insert[0], 3 + language_len,
+ insert_newline_for_multiline)
+ back = fix_newline(text_to_insert[-1], 3,
+ insert_newline_for_multiline and not end_of_message)
+ else:
+ front = fix_newline(text_to_insert[0], 1,
+ insert_newline_for_inline)
+ back = fix_newline(text_to_insert[-1], 1,
+ insert_newline_for_inline and not end_of_message)
+
+ marker_widths = (front[0], back[0])
+ text_to_insert = ''.join([front[1], text_to_insert, back[1]])
+
+ # insertion invalidates iterator, let's use our start mark...
+ self.insert_and_format_code(buf, text_to_insert, language,
+ marker_widths, start_mark, other_tags)
+
+ iterator = buf.get_iter_at_mark(end_mark)
+ # the current end of the buffer's contents is the start for the
+ # next iteration
+ buf.move_mark(start_mark, iterator)
+
+ buf.delete_mark(start_mark)
+ buf.delete_mark(end_mark)
+
+ buf.end_user_action()
+
+ # We have to make sure this is the last thing we do (i.e. no calls to
+ # the other textview methods no more from here on), because the
+ # print_special_text method is resetting the plugin_modified variable...
+ self.textview.plugin_modified = True
+
+ def insert_and_format_code(self, buf, insert_text, language, marker, start_mark, other_tags=None):
+ start_iter = buf.get_iter_at_mark(start_mark)
+
+ if other_tags:
+ buf.insert_with_tags_by_name(start_iter, insert_text,
+ *other_tags)
+ else:
+ buf.insert(start_iter, insert_text)
+
+ start_iter = buf.get_iter_at_mark(start_mark)
+ tag_start = start_iter
+ tag_end = buf.get_end_iter()
+ s_code = start_iter.copy()
+ e_code = tag_end.copy()
+ s_code.forward_chars(marker[0])
+ e_code.backward_chars(marker[1])
+
+ log.debug("full text between tags: %s.", tag_start.get_text(tag_end))
+
+ self.format_code(buf, tag_start, s_code, tag_end, e_code, language)
+
+ self.textview.plugin_modified = True
+
+ # Set general code block format
+ tag = Gtk.TextTag.new()
+ if self.config.is_bgcolor_override_enabled():
+ tag.set_property('background', self.config.get_bgcolor())
+ tag.set_property('paragraph-background', self.config.get_bgcolor())
+ tag.set_property('font', self.config.get_font())
+ buf.get_tag_table().add(tag)
+ buf.apply_tag(tag, start_iter, buf.get_end_iter())
+
+ buf.end_user_action()
+
+ def __init__(self, config, textview):
+ self.last_end_mark = None
+ self.config = config
+ self.textview = textview
+
+class SyntaxHighlighterConfig:
+ def _create_lexer_list(self):
+ self.lexers = []
+
+ # Iteration over get_all_lexers() seems to be broken somehow. Workarround
+ all_lexers = get_all_lexers()
+ for lexer in all_lexers:
+ # We don't want to add lexers that we cant identify by name later
+ if lexer[1] is not None and lexer[1]:
+ self.lexers.append((lexer[0], lexer[1][0]))
+ self.lexers.sort()
+ return self.lexers
+
+ def get_lexer_by_name(self, name):
+ lexer = None
+ try:
+ lexer = get_lexer_by_name(name)
+ except:
+ pass
+ return lexer
+
+ def get_lexer_with_fallback(self, language):
+ lexer = self.get_lexer_by_name(language)
+ if lexer is None:
+ log.info("Falling back to default lexer for %s.",
+ self.get_default_lexer_name())
+ lexer = self.default_lexer[1]
+ return lexer
+
+ def set_font(self, font):
+ if font is None or font == "":
+ font = DEFAULT_FONT
+ self.config['font'] = font
+
+ def set_style(self, style):
+ if style is None or style == "":
+ style = DEFAULT_STYLE
+ self.config['style'] = style
+
+ def set_line_break_action(self, option):
+ if isinstance(option, int):
+ option = LineBreakOptions(option)
+ self.config['line_break'] = option
+
+ def set_default_lexer(self, name):
+ lexer = get_lexer_by_name(name)
+
+ if lexer is None and self.default_lexer is None:
+ log.error("Failed to get default lexer by name."\
+ "Falling back to simply using the first in the list.")
+ lexer = self.lexer_list[0]
+ name = lexer[0]
+ self.default_lexer = (name, lexer)
+ if lexer is None and self.default_lexer is not None:
+ log.info("Failed to get default lexer by name, keeping previous"\
+ "setting (lexer = %s).", self.default_lexer[0])
+ name = self.default_lexer[0]
+ else:
+ self.default_lexer = (name, lexer)
+
+ self.config['default_lexer'] = name
+
+ def set_bgcolor_override_enabled(self, state):
+ self.config['bgcolor_override'] = state
+
+ def set_bgcolor(self, color):
+ if isinstance(color, Gdk.Color):
+ color = color.to_string()
+ self.config['bgcolor'] = color
+
+ def set_code_marker_setting(self, option):
+ if isinstance(option, int):
+ option = CodeMarkerOptions(option)
+ self.config['code_marker'] = option
+
+ def get_default_lexer(self):
+ return self.default_lexer[1]
+
+ def get_default_lexer_name(self):
+ return self.default_lexer[0]
+
+ def get_lexer_list(self):
+ return self.lexer_list
+
+ def get_line_break_action(self):
+ # return int only
+
+ action = DEFAULT_LINE_BREAK.value
+ if 'line_break' in self.config:
+ # in case of legacy settings...
+ if isinstance(self.config['line_break'], int):
+ action = self.config['line_break']
+ else:
+ action = self.config['line_break'].value
+ return action
+
+ def get_font(self):
+ return DEFAULT_FONT \
+ if 'font' not in self.config \
+ else self.config['font']
+
+ def get_style_name(self):
+ return DEFAULT_STYLE \
+ if 'style' not in self.config \
+ else self.config['style']
+
+ def is_bgcolor_override_enabled(self):
+ return DEFAULT_OVERRIDE_BGCOLOR \
+ if 'bgcolor_override' not in self.config \
+ else self.config['bgcolor_override']
+
+ def get_bgcolor(self):
+ return DEFAULT_BGCOLOR \
+ if 'bgcolor' not in self.config \
+ else self.config['bgcolor']
+
+ def get_code_marker_setting(self):
+ return DEFAULT_CODE_MARKER_SETTING \
+ if 'code_marker' not in self.config \
+ else self.config['code_marker']
+
+ def get_styles_list(self):
+ return self.style_list
+
+ def __init__(self, config, default_lexer_name):
+ self.lexer_list = self._create_lexer_list()
+ self.style_list = [s for s in get_all_styles()]
+ self.default_lexer = None
+ self.config = config
+
+ self.style_list.sort()
+
+ self.set_default_lexer(default_lexer_name \
+ if not 'default_lexer' in self.config \
+ or self.config['default_lexer'] is None \
+ else self.config['default_lexer'])
+
+class SyntaxHighlighterPlugin(GajimPlugin):
+
+ @log_calls('SyntaxHighlighterPlugin')
+ def on_connect_with_chat_control(self, chat_control):
+ account = chat_control.contact.account.name
+ jid = chat_control.contact.jid
+ if account not in self.ccontrol:
+ self.ccontrol[account] = {}
+ self.ccontrol[account][jid] = ChatSyntaxHighlighter(
+ self.conf, chat_control.conv_textview)
+
+ @log_calls('SyntaxHighlighterPlugin')
+ def on_disconnect_from_chat_control(self, chat_control):
+ account = chat_control.contact.account.name
+ jid = chat_control.contact.jid
+ del self.ccontrol[account][jid]
+
+ @log_calls('SyntaxHighlighterPlugin')
+ def on_print_real_text(self, text_view, real_text, other_tags, graphics,
+ iterator, additional):
+ account = text_view.account
+ for jid in self.ccontrol[account]:
+ if self.ccontrol[account][jid].textview != text_view:
+ continue
+ self.ccontrol[account][jid].process_text(
+ real_text, other_tags, graphics, iterator, additional)
+ return
+
+
+ @log_calls('SyntaxHighlighterPlugin')
+ def init(self):
+ if ERROR_MSG:
+ self.activatable = False
+ self.available_text = ERROR_MSG
+ self.config_dialog = None
+ return
+
+
+ self.conf = SyntaxHighlighterConfig(self.config, DEFAULT_LEXER)
+
+ self.ccontrol = {}
+ self.config_dialog = SyntaxHighlighterPluginConfiguration(self)
+ self.config_default_values = {
+ 'default_lexer': (DEFAULT_LEXER, "Default Lexer"),
+ 'line_break': (DEFAULT_LINE_BREAK, "Add line break")
+ }
+ self.config_dialog.set_config(self.conf)
+
+ self.gui_extension_points = {
+ 'chat_control_base': (
+ self.on_connect_with_chat_control,
+ self.on_disconnect_from_chat_control
+ ),
+ 'print_real_text': (self.on_print_real_text, None),
+ }
--
GitLab