diff --git a/syntax_highlight/LICENSE b/syntax_highlight/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..9cecc1d4669ee8af2ca727a5d8cde10cd8b2d7cc --- /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 0000000000000000000000000000000000000000..8cfa9b37e3cd7a7014600ec6ab5c6028b91e4bae --- /dev/null +++ b/syntax_highlight/README.md @@ -0,0 +1,72 @@ +# 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](https://dev.gajim.org/gajim/gajim-plugins/#how-to-install). + + +### Manual Installation +To install the plugin manually clone it into Gajims plugins folder (should be +`~/.local/share/gajim/plugins/` on Linux or +`C:\Users\USERNAME\AppData\Roaming\Gajim\Plugins` on Windows): + +``` +cd ~/.local/share/gajim/plugins/ +git clone https://github.com/FlorianMuenchbach/gajim-syntax-highlight +``` + +Then restart Gajim and enable the plugin in the plugins menu. + + +## Usage + +Source code between `@@` tags will be highlighted in the chatbox. +You can test it by copying and sending the following text to one of your +contacts: +``` +@@def test(): + print("Hello, world!") +@@ +``` +(**Node:** your contact will not receive highlighted text unless she is also +using the plugin.) + +If you want to send code written in a programming language other than the +default, you can specify the language between the first `@@` and one additional +`@` tag: +``` +@@bash@ +echo "Hello, world" +@@ +``` + + +## 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. + + +## 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 0000000000000000000000000000000000000000..b23c192c82cbd9ff3c6a5e95225bc3b2bbf02ded --- /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 0000000000000000000000000000000000000000..29d82a84d3817b6b4c39364ef70a66a52be741de --- /dev/null +++ b/syntax_highlight/config_dialog.ui @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- Generated with glade 3.20.0 --> +<interface> + <requires lib="gtk+" version="2.16"/> + <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="textbuffer1"> + <property name="text">Plug-in decription should be displayed here. This text will be erased during PluginsWindow initialization.</property> + </object> + <object class="GtkWindow" id="window1"> + <property name="can_focus">False</property> + <child> + <object class="GtkVBox" id="vbox1"> + <property name="visible">True</property> + <property name="can_focus">False</property> + <property name="border_width">9</property> + <property name="spacing">3</property> + <property name="homogeneous">True</property> + <child> + <object class="GtkHBox" id="hbox111"> + <property name="visible">True</property> + <property name="can_focus">False</property> + <property name="border_width">3</property> + <property name="spacing">6</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:</property> + <property name="xalign">0</property> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">False</property> + <property name="position">0</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="expand">True</property> + <property name="fill">True</property> + <property name="position">1</property> + </packing> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">0</property> + </packing> + </child> + <child> + <object class="GtkHBox" id="hbox11"> + <property name="visible">True</property> + <property name="can_focus">False</property> + <property name="border_width">3</property> + <property name="spacing">18</property> + <child> + <object class="GtkLabel" id="label2"> + <property name="visible">True</property> + <property name="can_focus">False</property> + <property name="label" translatable="yes">Add Line breaks:</property> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">False</property> + <property name="position">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="expand">True</property> + <property name="fill">True</property> + <property name="position">1</property> + </packing> + </child> + </object> + <packing> + <property name="expand">True</property> + <property name="fill">True</property> + <property name="position">1</property> + </packing> + </child> + </object> + </child> + </object> +</interface> diff --git a/syntax_highlight/gtkformatter.py b/syntax_highlight/gtkformatter.py new file mode 100644 index 0000000000000000000000000000000000000000..69be36136b284101835ea0ff078036c619fb2bb7 --- /dev/null +++ b/syntax_highlight/gtkformatter.py @@ -0,0 +1,88 @@ +import gtk +import pango + +from pygments.formatter import Formatter + +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.last_mark = None + self.mark = options.get('start_mark', None) + + def insert(self, tb, pos, text): + tb.insert(pos, text) + return tb.get_end_iter() + + def get_tag(self, ttype, tb): + tag = None + if ttype in self.tags: + tag = self.tags[ttype] + else: + style = self.style.style_for_token(ttype) + tag = gtk.TextTag() + 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: + #TODO + 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: + #TODO + 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') + self.tags[ttype] = tag + tb.get_tag_table().add(tag) + return tag + + def set_insert_pos_mark(self, mark): + self.mark = mark + + def format(self, tokensource, tb=gtk.TextBuffer()): + if not isinstance(tb, gtk.TextBuffer): + raise TypeError("This Formatter expects a gtk.TextBuffer object as"\ + "'output' file argument.") + ltype = None + insert_at_iter = tb.get_iter_at_mark(self.mark) if not self.mark is None \ + else tb.get_end_iter() + lstart_iter = tb.create_mark(None, insert_at_iter, True) + lend_iter = tb.create_mark(None, insert_at_iter, False) + for ttype, value in tokensource: + if ttype == ltype: + eiter = self.insert(tb, tb.get_iter_at_mark(lend_iter), value) + #tb.move_mark(lend_iter, eiter) + else: + # set last buffer section properties + if not ltype is None: + # set properties + tag = self.get_tag(ltype, tb) + if not tag is None: + tb.apply_tag( + tag, + tb.get_iter_at_mark(lstart_iter), + tb.get_iter_at_mark(lend_iter)) + tb.move_mark(lstart_iter, tb.get_iter_at_mark(lend_iter)) + eiter = self.insert(tb, tb.get_iter_at_mark(lend_iter), value) + #tb.move_mark(lend_iter, eiter) + ltype = ttype + self.last_mark = lend_iter + + def get_last_mark(self): + return self.last_mark diff --git a/syntax_highlight/manifest.ini b/syntax_highlight/manifest.ini new file mode 100644 index 0000000000000000000000000000000000000000..60c565730142bff87e59d6ee2858b0216a479759 --- /dev/null +++ b/syntax_highlight/manifest.ini @@ -0,0 +1,9 @@ +[info] +name: Source Code Syntax highlight +short_name: syntax_highlight +version: 0.0.2 +description: Source Code Syntax Highlighting in the chatbox.<br/><br /><b>Note:</b> You need to have pygments installed. Please refer to the plugin's Wiki page for more information. +authors = Florian Muenchbach +homepage = https://dev.gajim.org/gajim/gajim-plugins/wikis/syntaxhighlightplugin +min_gajim_version: 0.16.4 +max_gajim_version: 0.16.9 diff --git a/syntax_highlight/syntax_highlight.png b/syntax_highlight/syntax_highlight.png new file mode 100644 index 0000000000000000000000000000000000000000..76796c2809f4852111222bd348bb01b02cc44f21 Binary files /dev/null and b/syntax_highlight/syntax_highlight.png differ diff --git a/syntax_highlight/syntax_highlight.py b/syntax_highlight/syntax_highlight.py new file mode 100644 index 0000000000000000000000000000000000000000..e59c5a252533acd63f34fb94ec8a843cbd636fcb --- /dev/null +++ b/syntax_highlight/syntax_highlight.py @@ -0,0 +1,278 @@ +import logging + +import gtk + +from plugins.helpers import log_calls, log +from plugins import GajimPlugin +from plugins.gui import GajimPluginConfigDialog + +PYGMENTS_MISSING = 'You are missing Python-Pygments.' +ERROR_MSG = '' + +log = logging.getLogger('gajim.plugin_system.syntax_highlight') +DEFAULT_LEXER = "python" +DEFAULT_LINE_BREAK = 2 # => Only on multi-line code blocks + +try: + import pygments + from pygments.lexers import get_lexer_by_name, get_all_lexers + from .gtkformatter import GTKFormatter +except Exception as e: + log.error("Import Error: %s.", e) + 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, ['vbox1', 'line_break_selection']) + hbox = self.xml.get_object('vbox1') + self.child.pack_start(hbox) + 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.line_break_combobox = self.xml.get_object('line_break_combobox') + + self.xml.connect_signals(self) + self.default_lexer_id = 0 + + def set_lexer_list(self, lexers): + self.lexers = lexers + default_lexer = self.plugin.config['default_lexer'] + for i, lexer in enumerate(self.lexers): + self.liststore.append([lexer[0]]) + if lexer[1] == default_lexer: + self.default_lexer_id = i + + def lexer_changed(self, widget): + self.default_lexer_id = self.default_lexer_combobox.get_active() + self.plugin.config['default_lexer'] = self.lexers[self.default_lexer_id][1] + + def line_break_changed(self, widget): + self.plugin.config['line_break'] = self.line_break_combobox.get_active() + + def on_run(self): + self.default_lexer_combobox.set_active(self.default_lexer_id) + self.line_break_combobox.set_active(self.plugin.config['line_break']) + +class SyntaxHighlighterPlugin(GajimPlugin): + def on_change(self, tb): + """ + called when conversation text widget changes + """ + end_iter = tb.get_end_iter() + eol_tag = tb.get_tag_table().lookup('eol') + + def split_list(list_): + newlist = [] + for i in range(0, len(list_)-1, 2): + newlist.append( [ list_[i], list_[i+1], ] ) + return newlist + + def get_lexer(language): + lexer = None + try: + lexer = get_lexer_by_name(language) + except: + pass + return lexer + + def get_lexer_with_fallback(language, default_lexer): + lexer = get_lexer(language) + if lexer is None: + log.info("Falling back to default lexer for %s.", + str(self.config['default_lexer'])) + lexer = get_lexer_by_name(default_lexer) + return lexer + + def insert_formatted_code(tb, language, code, mark=None, line_break=False): + lexer = None + + if language is None: + log.info("No Language specified. Falling back to default lexer: %s.", + str(self.config['default_lexer'])) + lexer = get_lexer(self.config['default_lexer']) + else: + log.debug("Using lexer for %s.", str(language)) + lexer = get_lexer_with_fallback(language, self.config['default_lexer']) + + if lexer is None: + it = tb.get_iter_at_mark(mark) + tb.insert(it, '\n') + else: + tokens = pygments.lex(code, lexer) + + if line_break: + log.debug("Inserting newline before code.") + it = tb.get_iter_at_mark(mark) + tb.insert(it, '\n') + it.forward_char() + tb.move_mark(mark, it) + + + formatter = GTKFormatter(start_mark=mark) + pygments.format(tokens, formatter, tb) + + endmark = formatter.get_last_mark() + if line_break and not endmark is None: + it = tb.get_iter_at_mark(endmark) + tb.insert(it, '\n') + log.debug("Inserting newline after code.") + + return tb + + def detect_language(tb, start_mark): + language = None + new_start = None + if not start_mark is None: + next_chars = None + lang_iter = tb.get_iter_at_mark(start_mark) + first_word_end = lang_iter.copy() + first_word_end.forward_word_end() + first_word_last_char = first_word_end.get_char() + + next_chars_iter = first_word_end.copy() + next_chars_iter.forward_chars(2) + next_chars = first_word_end.get_text(next_chars_iter) + log.debug("first_word_last_char: %s.", first_word_last_char) + if first_word_last_char == "@" and next_chars != "@@": + language = lang_iter.get_text(first_word_end) + log.debug("language: >>%s<<", language) + first_word_end.forward_char() + new_start = tb.create_mark(None, first_word_end, True) + return (language, new_start) + + def to_iter(tb, mark): + return tb.get_iter_at_mark(mark) + + def check_line_break(tb, start, end): + line_break = False + if self.config['line_break'] == 1: + line_break = True + elif self.config['line_break'] == 2: + # hackish way to check if this code block contains multiple + # lines. + # TODO find better method.... + multiline_test = to_iter(tb, start).copy() + multiline_test.forward_line() + line_break = multiline_test.in_range( + to_iter(tb, start), to_iter(tb, end)) + return line_break + + def replace_code_block(tb, s_tag, s_code, e_tag, e_code): + iter_range_full = (tb.get_iter_at_mark(s_tag), + tb.get_iter_at_mark(e_tag)) + + text_full = iter_range_full[0].get_text(iter_range_full[1]) + log.debug("full text to remove: %s.", text_full) + + tb.begin_user_action() + + language, code_start = detect_language(tb, s_code) + code_start = s_code if code_start is None else code_start + + line_break = check_line_break(tb, code_start, e_code) + + code = to_iter(tb, code_start).get_text(to_iter(tb, e_code)) + log.debug("full text to encode: %s.", code) + + # Delete code between and including tags + tb.delete(to_iter(tb, s_tag), to_iter(tb, e_tag)) + + insert_formatted_code(tb, language, code, mark=s_tag, + line_break=line_break) + + tb.end_user_action() + + def detect_tags(tb, start_it=None, end_it=None): + if not end_it: + end_it = tb.get_end_iter() + if not start_it: + eol_tag = tb.get_tag_table().lookup('eol') + start_it = end_it.copy() + start_it.backward_to_tag_toggle(eol_tag) + points = [] + tuple_found = start_it.forward_search('@@', + gtk.TEXT_SEARCH_TEXT_ONLY) + while tuple_found != None: + points.append((tb.create_mark(None, tuple_found[0], True), + tb.create_mark(None, tuple_found[1], True))) + tuple_found = tuple_found[1].forward_search('@@', + gtk.TEXT_SEARCH_TEXT_ONLY) + + for (s_tag, s_code), (e_code, e_tag) in split_list(points): + replace_code_block(tb, s_tag, s_code, e_tag, e_code) + + end_iter = tb.get_end_iter() + eol_tag = tb.get_tag_table().lookup('eol') + it = end_iter.copy() + it.backward_to_tag_toggle(eol_tag) + + it1 = it.copy() + it1.backward_char() + it1.backward_to_tag_toggle(eol_tag) + detect_tags(tb, it1, it) + + @log_calls('SyntaxHighlighterPlugin') + def connect_with_chat_control(self, control): + control_data = {} + tv = control.conv_textview.tv + + control_data['connection'] = tv.get_buffer().connect('changed', self.on_change) + log.debug("connection: %s.", str(control_data['connection'])) + control.syntax_highlighter_plugin_data = control_data + + @log_calls('SyntaxHighlighterPlugin') + def disconnect_from_chat_control(self, control): + control_data = control.syntax_highlighter_plugin_data + tv = control.conv_textview.tv + log.debug("disconnected: %s.", str(control_data['connection'])) + tv.get_buffer().disconnect(control_data['connection']) + + def create_lexer_list(self): + self.lexers = [] + + # Iteration over get_all_lexers() seems to be broken somehow. Workarround + all_lexers = get_all_lexers() + lexer = all_lexers.next() + while not lexer is None: + # We don't want to add lexers that we cant identify by name later + if not lexer[1] is None and len(lexer[1]) > 0: + self.lexers.append((lexer[0], lexer[1][0])) + try: + lexer = all_lexers.next() + except: + lexer = None + self.lexers.sort() + return self.lexers + + @log_calls('SyntaxHighlighterPlugin') + def init(self): + if ERROR_MSG: + self.activatable = False + self.available_text = ERROR_MSG + self.config_dialog = None + return + 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_lexer_list(self.create_lexer_list()) + + self.gui_extension_points = { + 'chat_control_base': ( + self.connect_with_chat_control, + self.disconnect_from_chat_control + ), + } + self.timeout_id = None + self.last_eol_offset = -1