From a699693f4c55a2c6414580f39568e6f3415f1ecf Mon Sep 17 00:00:00 2001 From: Colomban Wendling Date: Mon, 11 Mar 2013 19:52:15 +0100 Subject: [PATCH 1/7] pohelper: Initial revision --- Makefile.am | 4 + build/pohelper.m4 | 11 + configure.ac | 1 + po/POTFILES.in | 2 + pohelper/AUTHORS | 1 + pohelper/COPYING | 674 ++++++++++++++++++++++++++++++++ pohelper/ChangeLog | 0 pohelper/Makefile.am | 4 + pohelper/NEWS | 3 + pohelper/README | 70 ++++ pohelper/src/Makefile.am | 13 + pohelper/src/gph-plugin.c | 767 +++++++++++++++++++++++++++++++++++++ pohelper/wscript_build | 33 ++ pohelper/wscript_configure | 1 + 14 files changed, 1584 insertions(+) create mode 100644 build/pohelper.m4 create mode 100644 pohelper/AUTHORS create mode 100644 pohelper/COPYING create mode 100644 pohelper/ChangeLog create mode 100644 pohelper/Makefile.am create mode 100644 pohelper/NEWS create mode 100644 pohelper/README create mode 100644 pohelper/src/Makefile.am create mode 100644 pohelper/src/gph-plugin.c create mode 100644 pohelper/wscript_build create mode 100644 pohelper/wscript_configure diff --git a/Makefile.am b/Makefile.am index a00d80d3c..3c1d40bf5 100644 --- a/Makefile.am +++ b/Makefile.am @@ -94,6 +94,10 @@ if ENABLE_MULTITERM SUBDIRS += multiterm endif +if ENABLE_POHELPER +SUBDIRS += pohelper +endif + if ENABLE_PRETTY_PRINTER SUBDIRS += pretty-printer endif diff --git a/build/pohelper.m4 b/build/pohelper.m4 new file mode 100644 index 000000000..122c116a1 --- /dev/null +++ b/build/pohelper.m4 @@ -0,0 +1,11 @@ +AC_DEFUN([GP_CHECK_POHELPER], +[ + GP_ARG_DISABLE([PoHelper], [yes]) + + GP_COMMIT_PLUGIN_STATUS([PoHelper]) + + AC_CONFIG_FILES([ + pohelper/Makefile + pohelper/src/Makefile + ]) +]) diff --git a/configure.ac b/configure.ac index 899656cd0..d784a00f5 100644 --- a/configure.ac +++ b/configure.ac @@ -47,6 +47,7 @@ GP_CHECK_GENIUSPASTE GP_CHECK_GPROJECT GP_CHECK_MARKDOWN GP_CHECK_MULTITERM +GP_CHECK_POHELPER GP_CHECK_PRETTYPRINTER GP_CHECK_SCOPE GP_CHECK_SHIFTCOLUMN diff --git a/po/POTFILES.in b/po/POTFILES.in index 74740112f..dab8167e7 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -211,6 +211,8 @@ gproject/src/gproject-sidebar.c markdown/src/conf.c markdown/src/plugin.c +# PoHelper +pohelper/src/gph-plugin.c # Pretty-printer pretty-printer/src/PrettyPrinter.c diff --git a/pohelper/AUTHORS b/pohelper/AUTHORS new file mode 100644 index 000000000..27eb5187d --- /dev/null +++ b/pohelper/AUTHORS @@ -0,0 +1 @@ +Colomban Wendling diff --git a/pohelper/COPYING b/pohelper/COPYING new file mode 100644 index 000000000..94a9ed024 --- /dev/null +++ b/pohelper/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/pohelper/ChangeLog b/pohelper/ChangeLog new file mode 100644 index 000000000..e69de29bb diff --git a/pohelper/Makefile.am b/pohelper/Makefile.am new file mode 100644 index 000000000..ff98b3ba0 --- /dev/null +++ b/pohelper/Makefile.am @@ -0,0 +1,4 @@ +include $(top_srcdir)/build/vars.auxfiles.mk + +SUBDIRS = src +plugin = pohelper diff --git a/pohelper/NEWS b/pohelper/NEWS new file mode 100644 index 000000000..ff22f0c69 --- /dev/null +++ b/pohelper/NEWS @@ -0,0 +1,3 @@ +Translation Helper 0.1 + + * Initial release. diff --git a/pohelper/README b/pohelper/README new file mode 100644 index 000000000..95bc142c9 --- /dev/null +++ b/pohelper/README @@ -0,0 +1,70 @@ +================== +Translation Helper +================== + +.. contents:: + + +About +===== + +Translation Helper is a plugin for Geany that improves the support for +GetText translation files, by providing various features specific to this +format and to translators. + + +Features +-------- + +* Navigation between untranslated or fuzzy messages; +* Reformatting of the translation (reflow); +* Pasting of the untranslated string to the translation; +* Automatic updating of the translation metadata. + + +Requirements +============ + +This plugin only requires GLib, GTK and Geany to work. If you intent to build +it yourself, you will need to get the development files of these programs and +libraries. You can find these packages at http://www.geany.org/ and +http://www.gtk.org/. + + +Installation +============ + +For detailed instructions, see the INSTALL file of the Geany-Plugins package +this plugin is part of. + + +Usage +===== + +First enbale the plugin the the Plugin Manager of Geany. The, you will be able +to configure keybindings for the various actions this plugin provides under +the Keybindings section of the Geany preferences. + + +License +======= + +Translation Helper is distributed 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. You should have received a copy +of the GNU General Public License along with WebHelper. If not, see +. + + +Contact +======= + +You can email me at , and I may also be on the +#geany channel on FreeNode, under the `b4n` nickname. + + +Bug reports and feature requests +-------------------------------- + +To report a bug or ask for a new feature, please use the Geany-Plugins tracker +on SourceForge: http://sourceforge.net/tracker/?group_id=222729 diff --git a/pohelper/src/Makefile.am b/pohelper/src/Makefile.am new file mode 100644 index 000000000..26b429fae --- /dev/null +++ b/pohelper/src/Makefile.am @@ -0,0 +1,13 @@ +include $(top_srcdir)/build/vars.build.mk +plugin = pohelper + +geanyplugins_LTLIBRARIES = pohelper.la + + +pohelper_la_SOURCES = gph-plugin.c +pohelper_la_CPPFLAGS = $(AM_CPPFLAGS) \ + -DG_LOG_DOMAIN=\"PoHelper\" +pohelper_la_CFLAGS = $(AM_CFLAGS) +pohelper_la_LIBADD = $(COMMONLIBS) + +include $(top_srcdir)/build/cppcheck.mk diff --git a/pohelper/src/gph-plugin.c b/pohelper/src/gph-plugin.c new file mode 100644 index 000000000..5194ef169 --- /dev/null +++ b/pohelper/src/gph-plugin.c @@ -0,0 +1,767 @@ +/* + * + * Copyright (C) 2013 Colomban Wendling + * + * 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 . + * + */ + +/* + * TODO: + * * add keybinding to toggle fuzzyness + * * allow to configure whether to update the metadata upon save + * * add a menu in the UI + */ + +#include "config.h" + +#include +#include +#include + +#include +#include +#include +#include + + +GeanyPlugin *geany_plugin; +GeanyData *geany_data; +GeanyFunctions *geany_functions; + + +PLUGIN_VERSION_CHECK (211) /* FIXME: what's the version really required? */ + +PLUGIN_SET_TRANSLATABLE_INFO ( + LOCALEDIR, GETTEXT_PACKAGE, + _("Translation helper"), + _("Improves support for GetText translation files."), + "0.1", + "Colomban Wendling " +) + + +enum { + GPH_KB_GOTO_PREV_UNTRANSLATED, + GPH_KB_GOTO_NEXT_UNTRANSLATED, + GPH_KB_GOTO_PREV_FUZZY, + GPH_KB_GOTO_NEXT_FUZZY, + GPH_KB_GOTO_PREV_UNTRANSLATED_OR_FUZZY, + GPH_KB_GOTO_NEXT_UNTRANSLATED_OR_FUZZY, + GPH_KB_PASTE_UNTRANSLATED, + GPH_KB_REFLOW, + GPH_KB_COUNT +}; + + +#define doc_is_po(doc) (DOC_VALID (doc) && \ + (doc)->file_type && \ + (doc)->file_type->id == GEANY_FILETYPES_PO) + + +/* + * find_style: + * @sci: a #ScintillaObject + * @style: a style ID to search for + * @start: start of the search range + * @end: end of the search range + * + * Search for a style in a #ScintillaObject. Backward search is possible if + * start is > end. Note that this find the first occurrence of @style in the + * search direction, which means that the start of the style will be found when + * searching onwards but the end when searching backwards. Also, if the start + * position is already on the style to search for this position is returned + * rather than one bound. + * + * Returns: The first found position with style @style, or -1 if not found in + * the given range. + */ +static gint +find_style (ScintillaObject *sci, + gint style, + gint start, + gint end) +{ + gint pos; + + if (start > end) { /* search backwards */ + for (pos = start; pos >= end; pos--) { + if (sci_get_style_at (sci, pos) == style) + break; + } + if (pos < end) + return -1; + } else { + for (pos = start; pos < end; pos++) { + if (sci_get_style_at (sci, pos) == style) + break; + } + if (pos >= end) + return -1; + } + + return pos; +} + +/* + * find_message: + * @doc: A #GeanyDocument + * @start: start of the search range + * @end: end of the search range + * + * Finds the start position of the next msgstr in the given range. If start is + * > end, searches backwards. + * + * Returns: The start position of the next msgstr in the given range, or -1 if + * not found. + */ +static gint +find_message (GeanyDocument *doc, + gint start, + gint end) +{ + if (doc_is_po (doc)) { + ScintillaObject *sci = doc->editor->sci; + gint pos = find_style (sci, SCE_PO_MSGSTR, start, end); + + if (pos >= 0) { + pos = find_style (sci, SCE_PO_MSGSTR_TEXT, pos, sci_get_length (sci)); + if (pos >= 0) { + return pos + 1; + } + } + } + + return -1; +} + +/* + * find_untranslated: + * @doc: A #GeanyDocument + * @start: start of the search range + * @end: end of the search range + * + * Searches for the next untranslated message in the given range. If start is + * > end, searches backwards. + * + * Returns: The start position of the next untranslated message in the given + * range, or -1 if not found. + */ +static gint +find_untranslated (GeanyDocument *doc, + gint start, + gint end) +{ + if (doc_is_po (doc)) { + ScintillaObject *sci = doc->editor->sci; + gboolean backwards = start > end; + + while (start >= 0) { + gint pos; + + if (backwards) { + start = find_style (sci, SCE_PO_MSGID, start, end); + } + + pos = find_message (doc, start, end); + if (pos < 0) { + return -1; + } else { + gint i = pos; + + for (i = pos; i < sci_get_length (sci); i++) { + gint style = sci_get_style_at (sci, i); + + if (style == SCE_PO_MSGSTR_TEXT) { + if (sci_get_char_at (sci, i) != '"') { + /* if any character in the text is not a delimiter, there's a + * translation */ + i = -1; + break; + } + } else if (style != SCE_PO_DEFAULT) { + /* if we reached something else than the text and the background, + * we're done searching */ + break; + } + } + if (i >= 0) + return pos; + } + + start = pos; + } + } + + return -1; +} + +static gint +find_prev_untranslated (GeanyDocument *doc) +{ + return find_untranslated (doc, sci_get_current_position (doc->editor->sci), + 0); +} + +static gint +find_next_untranslated (GeanyDocument *doc) +{ + return find_untranslated (doc, sci_get_current_position (doc->editor->sci), + sci_get_length (doc->editor->sci)); +} + +static gint +find_fuzzy (GeanyDocument *doc, + gint start, + gint end) +{ + if (doc_is_po (doc)) { + ScintillaObject *sci = doc->editor->sci; + + if (start > end) { + /* if searching backwards, first go to the previous msgstr not to find + * the current one */ + gint style = sci_get_style_at (sci, start); + + if (style == SCE_PO_MSGSTR || style == SCE_PO_MSGSTR_TEXT) { + start = find_style (sci, SCE_PO_MSGID, start, end); + if (start >= 0) { + start = find_style (sci, SCE_PO_MSGSTR, start, end); + } + } + } + + if (start >= 0) { + struct Sci_TextToFind ttf; + + ttf.chrg.cpMin = start; + ttf.chrg.cpMax = end; + ttf.lpstrText = (gchar *)"fuzzy"; + + while (sci_find_text (sci, SCFIND_WHOLEWORD | SCFIND_MATCHCASE, + &ttf) >= 0) { + gint style = sci_get_style_at (sci, (gint) ttf.chrgText.cpMin); + + if (style == SCE_PO_FUZZY || style == SCE_PO_FLAGS) { + /* OK, now find the start of the translation */ + return find_message (doc, (gint) ttf.chrgText.cpMax, + start > end ? sci_get_length (sci) : end); + } + + ttf.chrg.cpMin = start > end ? ttf.chrgText.cpMin : ttf.chrgText.cpMax; + } + } + } + + return -1; +} + +static gint +find_prev_fuzzy (GeanyDocument *doc) +{ + return find_fuzzy (doc, sci_get_current_position (doc->editor->sci), 0); +} + +static gint +find_next_fuzzy (GeanyDocument *doc) +{ + return find_fuzzy (doc, sci_get_current_position (doc->editor->sci), + sci_get_length (doc->editor->sci)); +} + +/* goto */ + +static void +goto_prev_untranslated (GeanyDocument *doc) +{ + if (doc_is_po (doc)) { + gint pos = find_prev_untranslated (doc); + + if (pos >= 0) { + editor_goto_pos (doc->editor, pos, FALSE); + } + } +} + +static void +goto_next_untranslated (GeanyDocument *doc) +{ + if (doc_is_po (doc)) { + gint pos = find_next_untranslated (doc); + + if (pos >= 0) { + editor_goto_pos (doc->editor, pos, FALSE); + } + } +} + +static void +goto_prev_fuzzy (GeanyDocument *doc) +{ + if (doc_is_po (doc)) { + gint pos = find_prev_fuzzy (doc); + + if (pos >= 0) { + editor_goto_pos (doc->editor, pos, FALSE); + } + } +} + +static void +goto_next_fuzzy (GeanyDocument *doc) +{ + if (doc_is_po (doc)) { + gint pos = find_next_fuzzy (doc); + + if (pos >= 0) { + editor_goto_pos (doc->editor, pos, FALSE); + } + } +} + +static void +goto_prev_untranslated_or_fuzzy (GeanyDocument *doc) +{ + if (doc_is_po (doc)) { + gint pos1 = find_prev_untranslated (doc); + gint pos2 = find_prev_fuzzy (doc); + + if (pos1 >= 0 || pos2 >= 0) { + editor_goto_pos (doc->editor, MAX (pos1, pos2), FALSE); + } + } +} + +static void +goto_next_untranslated_or_fuzzy (GeanyDocument *doc) +{ + if (doc_is_po (doc)) { + gint pos1 = find_next_untranslated (doc); + gint pos2 = find_next_fuzzy (doc); + + if (pos1 >= 0 || pos2 >= 0) { + editor_goto_pos (doc->editor, MIN (pos1, pos2), FALSE); + } + } +} + +/* basic regex search/replace without captures or back references */ +static gboolean +regex_replace (ScintillaObject *sci, + const gchar *scire, + const gchar *repl) +{ + struct Sci_TextToFind ttf; + + ttf.chrg.cpMin = 0; + ttf.chrg.cpMax = sci_get_length (sci); + ttf.lpstrText = (gchar *) scire; + + if (sci_find_text (sci, SCFIND_REGEXP, &ttf)) { + sci_set_target_start (sci, (gint) ttf.chrgText.cpMin); + sci_set_target_end (sci, (gint) ttf.chrgText.cpMax); + sci_replace_target (sci, repl, FALSE); + + return TRUE; + } + + return FALSE; +} + +static void +on_document_save (GObject *obj, + GeanyDocument *doc, + gpointer user_data) +{ + if (doc_is_po (doc)) { + gboolean update_header = TRUE; /* FIXME: make this configurable */ + + if (update_header) { + gchar *date; + gchar *translator; + + date = utils_get_date_time ("\"PO-Revision-Date: %Y-%m-%d %H:%M%z\\n\"", + NULL); + translator = g_strdup_printf ("\"Last-Translator: %s <%s>\\n\"", + geany_data->template_prefs->developer, + geany_data->template_prefs->mail); + + sci_start_undo_action (doc->editor->sci); + regex_replace (doc->editor->sci, "^\"PO-Revision-Date: .*\"$", date); + regex_replace (doc->editor->sci, "^\"Last-Translator: .*\"$", translator); + sci_end_undo_action (doc->editor->sci); + + g_free (date); + g_free (translator); + } + } +} + +static void +on_kb_goto_prev_untranslated (guint key_id) +{ + goto_prev_untranslated (document_get_current ()); +} + +static void +on_kb_goto_next_untranslated (guint key_id) +{ + goto_next_untranslated (document_get_current ()); +} + +static void +on_kb_goto_prev_fuzzy (guint key_id) +{ + goto_prev_fuzzy (document_get_current ()); +} + +static void +on_kb_goto_next_fuzzy (guint key_id) +{ + goto_next_fuzzy (document_get_current ()); +} + +static void +on_kb_goto_prev_untranslated_or_fuzzy (guint key_id) +{ + goto_prev_untranslated_or_fuzzy (document_get_current ()); +} + +static void +on_kb_goto_next_untranslated_or_fuzzy (guint key_id) +{ + goto_next_untranslated_or_fuzzy (document_get_current ()); +} + +/* + * on_kb_paste_untranslated: + * @key_id: unused + * + * Replaces the msgstr at the current position with it corresponding msgid. + */ +static void +on_kb_paste_untranslated (guint key_id) +{ + GeanyDocument *doc = document_get_current (); + + if (doc_is_po (doc)) { + ScintillaObject *sci = doc->editor->sci; + gint pos = sci_get_current_position (sci); + gint style = sci_get_style_at (sci, pos); + + while (pos > 0 && style == SCE_PO_DEFAULT) { + style = sci_get_style_at (sci, --pos); + } + + if (style == SCE_PO_MSGID_TEXT || + style == SCE_PO_MSGSTR || + style == SCE_PO_MSGSTR_TEXT) { + pos = find_style (sci, SCE_PO_MSGID, pos, 0); + if (pos >= 0) + style = SCE_PO_MSGID; + } + + if (style == SCE_PO_MSGID) { + gint start = find_style (sci, SCE_PO_MSGID_TEXT, + pos, sci_get_length (sci)); + + if (start >= 0) { + gchar *msgid; + gint end = start; + + /* find msgid range and copy it */ + for (pos = start + 1; pos < sci_get_length (sci); pos++) { + style = sci_get_style_at (sci, pos); + if (style == SCE_PO_MSGID_TEXT) + end = pos; + else if (style != SCE_PO_DEFAULT) + break; + } + + if (end - start <= 2 /* 2 is because we include the quotes */) { + /* don't allow replacing the header (empty) msgid */ + } else { + msgid = sci_get_contents_range (sci, start, end); + + start = find_style (sci, SCE_PO_MSGSTR_TEXT, end, + sci_get_length (sci)); + if (start >= 0) { + /* find msgstr range and replace it */ + end = start; + sci_set_target_start (sci, start); + for (pos = start; pos < sci_get_length (sci); pos++) { + style = sci_get_style_at (sci, pos); + if (style == SCE_PO_MSGSTR_TEXT) + end = pos; + else if (style != SCE_PO_DEFAULT) + break; + } + sci_set_target_end (sci, end); + sci_replace_target (sci, msgid, FALSE); + scintilla_send_message (sci, SCI_GOTOPOS, (uptr_t) start + 1, 0); + } + g_free (msgid); + } + } + } + } +} + +/* finds the start of the msgstr text at @pos. the returned position is the + * start of the msgstr text style, so it's on the first opening quote. Returns + * -1 if none found */ +static gint +find_msgstr_start_at (GeanyDocument *doc, + gint pos) +{ + if (doc_is_po (doc)) { + ScintillaObject *sci = doc->editor->sci; + gint style = sci_get_style_at (sci, pos); + + /* find the previous non-default style */ + while (pos > 0 && style == SCE_PO_DEFAULT) { + style = sci_get_style_at (sci, --pos); + } + + /* if a msgid or msgstr, go to the msgstr keyword */ + if (style == SCE_PO_MSGID || + style == SCE_PO_MSGID_TEXT || + style == SCE_PO_MSGSTR_TEXT) { + pos = find_style (sci, SCE_PO_MSGSTR, pos, + style == SCE_PO_MSGSTR_TEXT ? 0 : sci_get_length (sci)); + if (pos >= 0) + style = SCE_PO_MSGSTR; + } + + if (style == SCE_PO_MSGSTR) { + return find_style (sci, SCE_PO_MSGSTR_TEXT, pos, sci_get_length (sci)); + } + } + + return -1; +} + +/* like find_msgstr_start_at() but finds the end rather than the start */ +static gint +find_msgstr_end_at (GeanyDocument *doc, + gint pos) +{ + pos = find_msgstr_start_at (doc, pos); + if (pos >= 0) { + ScintillaObject *sci = doc->editor->sci; + gint end = pos; + + for (; pos < sci_get_length (sci); pos++) { + gint style = sci_get_style_at (sci, pos); + + if (style == SCE_PO_MSGSTR_TEXT) + end = pos; + else if (style != SCE_PO_DEFAULT) + break; + } + + return end; + } + + return -1; +} + +static GString * +get_msgstr_text_at (GeanyDocument *doc, + gint pos) +{ + pos = find_msgstr_start_at (doc, pos); + + if (pos >= 0) { + ScintillaObject *sci = doc->editor->sci; + GString *msgstr = g_string_new (NULL); + + while (sci_get_style_at (sci, pos) == SCE_PO_MSGSTR_TEXT) { + pos++; /* skip opening quote */ + while (sci_get_style_at (sci, pos + 1) == SCE_PO_MSGSTR_TEXT) { + g_string_append_c (msgstr, sci_get_char_at (sci, pos)); + pos++; + } + pos++; /* skip closing quote */ + + /* skip until next non-default style */ + while (sci_get_style_at (sci, pos) == SCE_PO_DEFAULT) { + pos++; + } + } + + return msgstr; + } + + return NULL; +} + +/* cuts @str in human-readable chunks for max @len. + * cuts first at \n, then at spaces and punctuation */ +/* FIXME: support utf-8 */ +static gchar ** +split_msg (const gchar *str, + gint len) +{ + GPtrArray *chunks = g_ptr_array_new (); + + g_return_val_if_fail (len >= 0, NULL); + + while (*str) { + GString *chunk = g_string_sized_new ((gsize) len); + + while (*str) { + const gchar *nl = strstr (str, "\\n"); + const gchar *p = strpbrk (str, " \t\v\r\n?!,.;:"); + + if (nl) + nl += 2; + + if (p) + p++; + else /* if there is no separator, use the end of the string */ + p = strchr (str, 0); + + if (nl && (chunk->len + nl - str <= len || + (nl < p && chunk->len == 0))) { + g_string_append_len (chunk, str, nl - str); + str = nl; + break; + } else if (chunk->len + p - str <= len || + chunk->len == 0) { + g_string_append_len (chunk, str, p - str); + str = p; + } else { + /* give up and leave to next chunk */ + break; + } + } + g_ptr_array_add (chunks, g_string_free (chunk, FALSE)); + } + + g_ptr_array_add (chunks, NULL); + + return (gchar **) g_ptr_array_free (chunks, FALSE); +} + +static void +on_kb_reflow (guint key_id) +{ + GeanyDocument *doc = document_get_current (); + + if (doc_is_po (doc)) { + ScintillaObject *sci = doc->editor->sci; + gint pos = sci_get_current_position (sci); + GString *msgstr = get_msgstr_text_at (doc, pos); + + if (msgstr) { + gint start = find_msgstr_start_at (doc, pos); + gint end = find_msgstr_end_at (doc, pos); + glong len = g_utf8_strlen (msgstr->str, msgstr->len); + /* FIXME: line_break_column isn't supposedly public */ + gint line_len = geany_data->editor_prefs->line_break_column; + gint msgstr_kw_len; + + sci_start_undo_action (sci); + scintilla_send_message (sci, SCI_DELETERANGE, + (uptr_t) start, end + 1 - start); + + msgstr_kw_len = start - sci_get_position_from_line (sci, sci_get_line_from_position (sci, start)); + if (msgstr_kw_len + len + 2 <= line_len) { + /* if all can go in the msgstr line, put it here */ + gchar *text = g_strconcat ("\"", msgstr->str, "\"", NULL); + sci_insert_text (sci, start, text); + g_free (text); + } else { + /* otherwise, put nothing on the msgstr line and split it up through + * next ones */ + gchar **chunks = split_msg (msgstr->str, line_len - 2); + guint i; + + sci_insert_text (sci, start, "\"\""); /* nothing on the msgstr line */ + start += 2; + for (i = 0; chunks[i]; i++) { + SETPTR (chunks[i], g_strconcat ("\n\"", chunks[i], "\"", NULL)); + sci_insert_text (sci, start, chunks[i]); + start += (gint) strlen (chunks[i]); + } + + g_strfreev (chunks); + } + + scintilla_send_message (sci, SCI_GOTOPOS, (uptr_t) (start + 1), 0); + sci_end_undo_action (sci); + + g_string_free (msgstr, TRUE); + } + } +} + +void +plugin_init (GeanyData *data) +{ + GeanyKeyGroup *group; + + plugin_signal_connect (geany_plugin, NULL, "document-before-save", TRUE, + G_CALLBACK (on_document_save), NULL); + + /* add keybindings */ + group = plugin_set_key_group (geany_plugin, "pohelper", GPH_KB_COUNT, NULL); + + keybindings_set_item (group, GPH_KB_GOTO_PREV_UNTRANSLATED, + on_kb_goto_prev_untranslated, 0, 0, + "goto-prev-untranslated", + _("Go to previous untranslated string"), + NULL); + keybindings_set_item (group, GPH_KB_GOTO_NEXT_UNTRANSLATED, + on_kb_goto_next_untranslated, 0, 0, + "goto-next-untranslated", + _("Go to next untranslated string"), + NULL); + keybindings_set_item (group, GPH_KB_GOTO_PREV_FUZZY, + on_kb_goto_prev_fuzzy, 0, 0, + "goto-prev-fuzzy", + _("Go to previous fuzzily translated string"), + NULL); + keybindings_set_item (group, GPH_KB_GOTO_NEXT_FUZZY, + on_kb_goto_next_fuzzy, 0, 0, + "goto-next-fuzzy", + _("Go to next fuzzily translated string"), + NULL); + keybindings_set_item (group, GPH_KB_GOTO_PREV_UNTRANSLATED_OR_FUZZY, + on_kb_goto_prev_untranslated_or_fuzzy, 0, 0, + "goto-prev-untranslated-or-fuzzy", + _("Go to previous untranslated or fuzzy string"), + NULL); + keybindings_set_item (group, GPH_KB_GOTO_NEXT_UNTRANSLATED_OR_FUZZY, + on_kb_goto_next_untranslated_or_fuzzy, 0, 0, + "goto-next-untranslated-or-fuzzy", + _("Go to next untranslated or fuzzy string"), + NULL); + keybindings_set_item (group, GPH_KB_PASTE_UNTRANSLATED, + on_kb_paste_untranslated, 0, 0, + "paste-untranslated", + _("Paste original untranslated string to translation"), + NULL); + keybindings_set_item (group, GPH_KB_REFLOW, + on_kb_reflow, 0, 0, + "reflow", + _("Reflow the translated string"), + NULL); +} + +void +plugin_cleanup (void) +{ +} diff --git a/pohelper/wscript_build b/pohelper/wscript_build new file mode 100644 index 000000000..8d78be3f7 --- /dev/null +++ b/pohelper/wscript_build @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# WAF build script for geany-plugins - Translation Helper +# +# Copyright 2010 Enrico Tröger +# Copyright 2013 Colomban Wendling +# +# 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 2 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, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +# + +from build.wafutils import build_plugin + + +name = 'PoHelper' + +sources = ['src/gph-plugin.c'] +includes = ['src'] + +build_plugin(bld, name, + sources=sources, + includes=includes) diff --git a/pohelper/wscript_configure b/pohelper/wscript_configure new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/pohelper/wscript_configure @@ -0,0 +1 @@ + From 2a12866dae5b16e615f389eed40159e278d9093a Mon Sep 17 00:00:00 2001 From: Colomban Wendling Date: Tue, 12 Mar 2013 00:15:04 +0100 Subject: [PATCH 2/7] pohelper: Implement message fuzziness toggling --- pohelper/README | 1 + pohelper/src/gph-plugin.c | 184 +++++++++++++++++++++++++++++++++++++- 2 files changed, 184 insertions(+), 1 deletion(-) diff --git a/pohelper/README b/pohelper/README index 95bc142c9..ca7471c06 100644 --- a/pohelper/README +++ b/pohelper/README @@ -18,6 +18,7 @@ Features * Navigation between untranslated or fuzzy messages; * Reformatting of the translation (reflow); +* Toggling the fuzziness of a translation; * Pasting of the untranslated string to the translation; * Automatic updating of the translation metadata. diff --git a/pohelper/src/gph-plugin.c b/pohelper/src/gph-plugin.c index 5194ef169..d990a5fed 100644 --- a/pohelper/src/gph-plugin.c +++ b/pohelper/src/gph-plugin.c @@ -19,7 +19,6 @@ /* * TODO: - * * add keybinding to toggle fuzzyness * * allow to configure whether to update the metadata upon save * * add a menu in the UI */ @@ -61,6 +60,7 @@ enum { GPH_KB_GOTO_NEXT_UNTRANSLATED_OR_FUZZY, GPH_KB_PASTE_UNTRANSLATED, GPH_KB_REFLOW, + GPH_KB_TOGGLE_FUZZY, GPH_KB_COUNT }; @@ -708,6 +708,183 @@ on_kb_reflow (guint key_id) } } +/* returns the first non-default style on the line, or the default style if + * there is no other on that line */ +static gint +find_first_non_default_style_on_line (ScintillaObject *sci, + gint line) +{ + gint pos = sci_get_position_from_line (sci, line); + gint end = sci_get_line_end_position (sci, line); + gint style; + + do { + style = sci_get_style_at (sci, pos++); + } while (style == SCE_PO_DEFAULT && pos < end); + + return style; +} + +/* parse flags line @line and puts the read flags in @flags + * a flags line looks like: + * #, flag-1, flag-2, flag-2, ... */ +static void +parse_flags_line (ScintillaObject *sci, + gint line, + GPtrArray *flags) +{ + gint start = sci_get_position_from_line (sci, line); + gint end = sci_get_line_end_position (sci, line); + gint pos; + gint ws, we; + gint ch; + + pos = start; + /* skip leading space and markers */ + while (pos <= end && ((ch = sci_get_char_at (sci, pos)) == '#' || + ch == ',' || g_ascii_isspace (ch))) { + pos++; + } + /* and read the flags */ + for (ws = we = pos; pos <= end; pos++) { + ch = sci_get_char_at (sci, pos); + + if (ch == ',' || g_ascii_isspace (ch) || pos >= end) { + if (ws < we) { + g_ptr_array_add (flags, sci_get_contents_range (sci, ws, we + 1)); + } + ws = pos + 1; + } else { + we = pos; + } + } +} + +/* adds or remove @flag from @flags. returns whether the flag was added */ +static gboolean +toggle_flag (GPtrArray *flags, + const gchar *flag) +{ + gboolean add = TRUE; + guint i; + + /* search for the flag and remove it */ + for (i = 0; i < flags->len; i++) { + if (strcmp (g_ptr_array_index (flags, i), flag) == 0) { + g_ptr_array_remove_index (flags, i); + add = FALSE; + break; + } + } + /* if it wasntt there, add it */ + if (add) { + g_ptr_array_add (flags, g_strdup (flag)); + } + + return add; +} + +/* writes a flags line at @pos containgin @flags */ +static void +write_flags (ScintillaObject *sci, + gint pos, + GPtrArray *flags) +{ + if (flags->len > 0) { + guint i; + + sci_start_undo_action (sci); + sci_insert_text (sci, pos, "#"); + pos ++; + for (i = 0; i < flags->len; i++) { + const gchar *flag = g_ptr_array_index (flags, i); + + sci_insert_text (sci, pos, ", "); + pos += 2; + sci_insert_text (sci, pos, flag); + pos += (gint) strlen (flag); + } + sci_insert_text (sci, pos, "\n"); + sci_end_undo_action (sci); + } +} + +static void +delete_line (ScintillaObject *sci, + gint line) +{ + gint pos = sci_get_position_from_line (sci, line); + gint length = sci_get_line_length (sci, line); + + scintilla_send_message (sci, SCI_DELETERANGE, (uptr_t) pos, (sptr_t) length); +} + +static void +on_kb_toggle_fuzziness (guint key_id) +{ + GeanyDocument *doc = document_get_current (); + + if (doc_is_po (doc)) { + ScintillaObject *sci = doc->editor->sci; + gint pos = sci_get_current_position (sci); + gint line = sci_get_line_from_position (sci, pos); + gint style = find_first_non_default_style_on_line (sci, line); + + /* find the msgid for the current line */ + while (line > 0 && + (style == SCE_PO_MSGID_TEXT || + style == SCE_PO_MSGSTR || + style == SCE_PO_MSGSTR_TEXT)) { + line--; + style = find_first_non_default_style_on_line (sci, line); + } + while (line < sci_get_line_count (sci) && + (style == SCE_PO_COMMENT || + style == SCE_PO_PROGRAMMER_COMMENT || + style == SCE_PO_REFERENCE || + style == SCE_PO_FLAGS || + style == SCE_PO_FUZZY)) { + line++; + style = find_first_non_default_style_on_line (sci, line); + } + + if (style == SCE_PO_MSGID) { + gint msgid_line = line; + GPtrArray *flags = g_ptr_array_new (); + + sci_start_undo_action (sci); + + if (line > 0) { + /* search for an existing flags line */ + do { + line--; + style = find_first_non_default_style_on_line (sci, line); + } while (line > 0 && + (style == SCE_PO_COMMENT || + style == SCE_PO_PROGRAMMER_COMMENT || + style == SCE_PO_REFERENCE)); + + if (style == SCE_PO_FLAGS || style == SCE_PO_FUZZY) { + /* ok we got a line with flags, parse them and remove them */ + parse_flags_line (sci, line, flags); + delete_line (sci, line); + } else { + /* no flags, add the line */ + line = msgid_line; + } + } + + toggle_flag (flags, "fuzzy"); + write_flags (sci, sci_get_position_from_line (sci, line), flags); + + sci_end_undo_action (sci); + + g_ptr_array_foreach (flags, (GFunc) g_free, NULL); + g_ptr_array_free (flags, TRUE); + } + } +} + void plugin_init (GeanyData *data) { @@ -759,6 +936,11 @@ plugin_init (GeanyData *data) "reflow", _("Reflow the translated string"), NULL); + keybindings_set_item (group, GPH_KB_TOGGLE_FUZZY, + on_kb_toggle_fuzziness, 0, 0, + "toggle-fuzziness", + _("Toggle fuzziness of the translated string"), + NULL); } void From cc8a8ba90591fcefc1700377fd33ea18975dc783 Mon Sep 17 00:00:00 2001 From: Colomban Wendling Date: Tue, 12 Mar 2013 00:47:52 +0100 Subject: [PATCH 3/7] pohelper: Add keybindings to go to any previous/next message Add keybindings for previous and next message, no matter whether they are translated or not. --- pohelper/README | 2 +- pohelper/src/gph-plugin.c | 53 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 1 deletion(-) diff --git a/pohelper/README b/pohelper/README index ca7471c06..71b7a2503 100644 --- a/pohelper/README +++ b/pohelper/README @@ -16,7 +16,7 @@ format and to translators. Features -------- -* Navigation between untranslated or fuzzy messages; +* Navigation between all, untranslated or fuzzy messages; * Reformatting of the translation (reflow); * Toggling the fuzziness of a translation; * Pasting of the untranslated string to the translation; diff --git a/pohelper/src/gph-plugin.c b/pohelper/src/gph-plugin.c index d990a5fed..acf7fb783 100644 --- a/pohelper/src/gph-plugin.c +++ b/pohelper/src/gph-plugin.c @@ -52,6 +52,8 @@ PLUGIN_SET_TRANSLATABLE_INFO ( enum { + GPH_KB_GOTO_PREV, + GPH_KB_GOTO_NEXT, GPH_KB_GOTO_PREV_UNTRANSLATED, GPH_KB_GOTO_NEXT_UNTRANSLATED, GPH_KB_GOTO_PREV_FUZZY, @@ -282,6 +284,35 @@ find_next_fuzzy (GeanyDocument *doc) /* goto */ +static void +goto_prev (GeanyDocument *doc) +{ + if (doc_is_po (doc)) { + gint pos = sci_get_current_position (doc->editor->sci); + + pos = find_style (doc->editor->sci, SCE_PO_MSGID, pos, 0); + if (pos >= 0) { + pos = find_message (doc, pos, 0); + if (pos >= 0) { + editor_goto_pos (doc->editor, pos, FALSE); + } + } + } +} + +static void +goto_next (GeanyDocument *doc) +{ + if (doc_is_po (doc)) { + gint pos = find_message (doc, sci_get_current_position (doc->editor->sci), + sci_get_length (doc->editor->sci)); + + if (pos >= 0) { + editor_goto_pos (doc->editor, pos, FALSE); + } + } +} + static void goto_prev_untranslated (GeanyDocument *doc) { @@ -408,6 +439,18 @@ on_document_save (GObject *obj, } } +static void +on_kb_goto_prev (guint key_id) +{ + goto_prev (document_get_current ()); +} + +static void +on_kb_goto_next (guint key_id) +{ + goto_next (document_get_current ()); +} + static void on_kb_goto_prev_untranslated (guint key_id) { @@ -896,6 +939,16 @@ plugin_init (GeanyData *data) /* add keybindings */ group = plugin_set_key_group (geany_plugin, "pohelper", GPH_KB_COUNT, NULL); + keybindings_set_item (group, GPH_KB_GOTO_PREV, + on_kb_goto_prev, 0, 0, + "goto-prev", + _("Go to previous string"), + NULL); + keybindings_set_item (group, GPH_KB_GOTO_NEXT, + on_kb_goto_next, 0, 0, + "goto-next", + _("Go to next string"), + NULL); keybindings_set_item (group, GPH_KB_GOTO_PREV_UNTRANSLATED, on_kb_goto_prev_untranslated, 0, 0, "goto-prev-untranslated", From cff6972c25acab79c33435bf296a448a6b8b125e Mon Sep 17 00:00:00 2001 From: Colomban Wendling Date: Tue, 12 Mar 2013 01:19:26 +0100 Subject: [PATCH 4/7] pohelper: Properly escape inserted name and email Make sure inserted name and email don't contain control characters such as quotes (") or backslashes (\). --- pohelper/src/gph-plugin.c | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/pohelper/src/gph-plugin.c b/pohelper/src/gph-plugin.c index acf7fb783..d3f7d4971 100644 --- a/pohelper/src/gph-plugin.c +++ b/pohelper/src/gph-plugin.c @@ -410,6 +410,35 @@ regex_replace (ScintillaObject *sci, return FALSE; } +/* escapes @str so it is valid to put it inside a message + * escapes '\b', '\f', '\n', '\r', '\t', '\v', '\' and '"' + * unlike g_strescape(), it doesn't escape non-ASCII characters so keeps + * all of UTF-8 */ +static gchar * +escape_string (const gchar *str) +{ + gchar *new = g_malloc (strlen (str) * 2 + 1); + gchar *p; + + for (p = new; *str; str++) { + switch (*str) { + case '\b': *p++ = '\\'; *p++ = 'b'; break; + case '\f': *p++ = '\\'; *p++ = 'f'; break; + case '\n': *p++ = '\\'; *p++ = 'n'; break; + case '\r': *p++ = '\\'; *p++ = 'r'; break; + case '\t': *p++ = '\\'; *p++ = 't'; break; + case '\v': *p++ = '\\'; *p++ = 'v'; break; + case '\\': *p++ = '\\'; *p++ = '\\'; break; + case '"': *p++ = '\\'; *p++ = '"'; break; + default: + *p++ = *str; + } + } + *p = 0; + + return new; +} + static void on_document_save (GObject *obj, GeanyDocument *doc, @@ -419,14 +448,15 @@ on_document_save (GObject *obj, gboolean update_header = TRUE; /* FIXME: make this configurable */ if (update_header) { + gchar *name = escape_string (geany_data->template_prefs->developer); + gchar *mail = escape_string (geany_data->template_prefs->mail); gchar *date; gchar *translator; date = utils_get_date_time ("\"PO-Revision-Date: %Y-%m-%d %H:%M%z\\n\"", NULL); translator = g_strdup_printf ("\"Last-Translator: %s <%s>\\n\"", - geany_data->template_prefs->developer, - geany_data->template_prefs->mail); + name, mail); sci_start_undo_action (doc->editor->sci); regex_replace (doc->editor->sci, "^\"PO-Revision-Date: .*\"$", date); @@ -435,6 +465,8 @@ on_document_save (GObject *obj, g_free (date); g_free (translator); + g_free (name); + g_free (mail); } } } From 55dd6b59828f82f9b3dd7512bcdcd212a2c1816b Mon Sep 17 00:00:00 2001 From: Colomban Wendling Date: Tue, 12 Mar 2013 03:33:46 +0100 Subject: [PATCH 5/7] pohelper: Fix reflow to use the number of characters, not bytes --- pohelper/src/gph-plugin.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pohelper/src/gph-plugin.c b/pohelper/src/gph-plugin.c index d3f7d4971..cbccc1877 100644 --- a/pohelper/src/gph-plugin.c +++ b/pohelper/src/gph-plugin.c @@ -684,7 +684,6 @@ get_msgstr_text_at (GeanyDocument *doc, /* cuts @str in human-readable chunks for max @len. * cuts first at \n, then at spaces and punctuation */ -/* FIXME: support utf-8 */ static gchar ** split_msg (const gchar *str, gint len) @@ -699,6 +698,7 @@ split_msg (const gchar *str, while (*str) { const gchar *nl = strstr (str, "\\n"); const gchar *p = strpbrk (str, " \t\v\r\n?!,.;:"); + glong chunk_len = g_utf8_strlen (chunk->str, (gssize) chunk->len); if (nl) nl += 2; @@ -708,12 +708,12 @@ split_msg (const gchar *str, else /* if there is no separator, use the end of the string */ p = strchr (str, 0); - if (nl && (chunk->len + nl - str <= len || + if (nl && ((chunk_len + g_utf8_strlen (str, nl - str)) <= len || (nl < p && chunk->len == 0))) { g_string_append_len (chunk, str, nl - str); str = nl; break; - } else if (chunk->len + p - str <= len || + } else if ((chunk_len + g_utf8_strlen (str, p - str)) <= len || chunk->len == 0) { g_string_append_len (chunk, str, p - str); str = p; @@ -743,7 +743,7 @@ on_kb_reflow (guint key_id) if (msgstr) { gint start = find_msgstr_start_at (doc, pos); gint end = find_msgstr_end_at (doc, pos); - glong len = g_utf8_strlen (msgstr->str, msgstr->len); + glong len = g_utf8_strlen (msgstr->str, (gssize) msgstr->len); /* FIXME: line_break_column isn't supposedly public */ gint line_len = geany_data->editor_prefs->line_break_column; gint msgstr_kw_len; From 946537f1e6f7da961d7c6d5c2cbfc4b718450d42 Mon Sep 17 00:00:00 2001 From: Colomban Wendling Date: Tue, 12 Mar 2013 20:30:35 +0100 Subject: [PATCH 6/7] pohelper: Add a menu under Tools --- build/pohelper.m4 | 1 + po/POTFILES.in | 1 + pohelper/Makefile.am | 2 +- pohelper/README | 8 +- pohelper/data/Makefile.am | 4 + pohelper/data/menus.ui | 223 ++++++++++++++++++++++++++++++++++++++ pohelper/src/gph-plugin.c | 162 +++++++++++++++++---------- pohelper/wscript_build | 7 +- 8 files changed, 346 insertions(+), 62 deletions(-) create mode 100644 pohelper/data/Makefile.am create mode 100644 pohelper/data/menus.ui diff --git a/build/pohelper.m4 b/build/pohelper.m4 index 122c116a1..50f39e951 100644 --- a/build/pohelper.m4 +++ b/build/pohelper.m4 @@ -6,6 +6,7 @@ AC_DEFUN([GP_CHECK_POHELPER], AC_CONFIG_FILES([ pohelper/Makefile + pohelper/data/Makefile pohelper/src/Makefile ]) ]) diff --git a/po/POTFILES.in b/po/POTFILES.in index dab8167e7..0be5563b6 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -212,6 +212,7 @@ markdown/src/conf.c markdown/src/plugin.c # PoHelper +[type: gettext/glade]pohelper/data/menus.ui pohelper/src/gph-plugin.c # Pretty-printer diff --git a/pohelper/Makefile.am b/pohelper/Makefile.am index ff98b3ba0..adc3e6d9a 100644 --- a/pohelper/Makefile.am +++ b/pohelper/Makefile.am @@ -1,4 +1,4 @@ include $(top_srcdir)/build/vars.auxfiles.mk -SUBDIRS = src +SUBDIRS = data src plugin = pohelper diff --git a/pohelper/README b/pohelper/README index 71b7a2503..1b1f013a1 100644 --- a/pohelper/README +++ b/pohelper/README @@ -42,9 +42,11 @@ this plugin is part of. Usage ===== -First enbale the plugin the the Plugin Manager of Geany. The, you will be able -to configure keybindings for the various actions this plugin provides under -the Keybindings section of the Geany preferences. +First enbale the plugin the the Plugin Manager of Geany. Once enabled, +the plugin adds a new menu under "Tools -> Translation Helper" giving +access to the various actions it provides. You can of course configure +keybindings for each actions under the Keybindings section of the Geany +preferences. License diff --git a/pohelper/data/Makefile.am b/pohelper/data/Makefile.am new file mode 100644 index 000000000..12d868dff --- /dev/null +++ b/pohelper/data/Makefile.am @@ -0,0 +1,4 @@ +include $(top_srcdir)/build/vars.docs.mk +plugin = pohelper + +dist_plugindata_DATA = menus.ui diff --git a/pohelper/data/menus.ui b/pohelper/data/menus.ui new file mode 100644 index 000000000..86b3f9c10 --- /dev/null +++ b/pohelper/data/menus.ui @@ -0,0 +1,223 @@ + + + + + + True + False + gtk-go-back + 1 + + + True + False + gtk-go-forward + 1 + + + True + False + gtk-go-back + 1 + + + True + False + gtk-go-forward + 1 + + + True + False + gtk-go-back + 1 + + + True + False + gtk-go-forward + 1 + + + True + False + gtk-go-back + 1 + + + True + False + gtk-go-forward + 1 + + + True + False + gtk-paste + 1 + + + False + True + False + _Translation Helper + True + + + False + + + _Previous String + False + True + False + Go to previous string + True + image1 + False + + + + + _Next String + False + True + False + Go to next string + True + image2 + False + + + + + True + False + + + + + Pre_vious Untranslated + False + True + False + Go to previous untranslated string + True + image3 + False + + + + + Next _Untranslated + False + True + False + Go to next untranslated string + True + image4 + False + + + + + True + False + + + + + Previous Fu_zzy + False + True + False + Go to previous fuzzily translated string + True + image5 + False + + + + + Next _Fuzzy + False + True + False + Go to next fuzzily translated string + True + image6 + False + + + + + True + False + + + + + Previous Untranslated or Fuzz_y + False + True + False + Go to previous untranslated or fuzzy string + True + image7 + False + + + + + Next Untranslated _or Fuzzy + False + True + False + Go to next untranslated or fuzzy string + True + image8 + False + + + + + True + False + + + + + False + True + False + Toggle current translation fuzziness + _Toggle Fuzziness + True + + + + + Paste _Message as Translation + False + True + False + Paste the original untranslated string to the translation + True + image9 + False + + + + + False + True + False + Reflow the current translation string + _Reflow Translation + True + + + + + + diff --git a/pohelper/src/gph-plugin.c b/pohelper/src/gph-plugin.c index cbccc1877..0b0f90594 100644 --- a/pohelper/src/gph-plugin.c +++ b/pohelper/src/gph-plugin.c @@ -20,7 +20,6 @@ /* * TODO: * * allow to configure whether to update the metadata upon save - * * add a menu in the UI */ #include "config.h" @@ -44,7 +43,7 @@ PLUGIN_VERSION_CHECK (211) /* FIXME: what's the version really required? */ PLUGIN_SET_TRANSLATABLE_INFO ( LOCALEDIR, GETTEXT_PACKAGE, - _("Translation helper"), + _("Translation Helper"), _("Improves support for GetText translation files."), "0.1", "Colomban Wendling " @@ -67,6 +66,11 @@ enum { }; +static struct Plugin { + GtkWidget *menu_item; +} plugin; + + #define doc_is_po(doc) (DOC_VALID (doc) && \ (doc)->file_type && \ (doc)->file_type->id == GEANY_FILETYPES_PO) @@ -960,75 +964,119 @@ on_kb_toggle_fuzziness (guint key_id) } } +static const struct Action { + guint id; + const gchar *name; + GeanyKeyCallback callback; + const gchar *label; + const gchar *widget; +} G_actions[] = { + { GPH_KB_GOTO_PREV, "goto-prev", + on_kb_goto_prev, + N_("Go to previous string"), "previous_string" }, + { GPH_KB_GOTO_NEXT, "goto-next", + on_kb_goto_next, + N_("Go to next string"), "next_string" }, + { GPH_KB_GOTO_PREV_UNTRANSLATED, "goto-prev-untranslated", + on_kb_goto_prev_untranslated, + N_("Go to previous untranslated string"), "previous_untranslated" }, + { GPH_KB_GOTO_NEXT_UNTRANSLATED, "goto-next-untranslated", + on_kb_goto_next_untranslated, + N_("Go to next untranslated string"), "next_untranslated" }, + { GPH_KB_GOTO_PREV_FUZZY, "goto-prev-fuzzy", + on_kb_goto_prev_fuzzy, + N_("Go to previous fuzzily translated string"), "previous_fuzzy" }, + { GPH_KB_GOTO_NEXT_FUZZY, "goto-next-fuzzy", + on_kb_goto_next_fuzzy, + N_("Go to next fuzzily translated string"), "next_fuzzy" }, + { GPH_KB_GOTO_PREV_UNTRANSLATED_OR_FUZZY, "goto-prev-untranslated-or-fuzzy", + on_kb_goto_prev_untranslated_or_fuzzy, + N_("Go to previous untranslated or fuzzy string"), + "previous_untranslated_or_fuzzy" }, + { GPH_KB_GOTO_NEXT_UNTRANSLATED_OR_FUZZY, "goto-next-untranslated-or-fuzzy", + on_kb_goto_next_untranslated_or_fuzzy, + N_("Go to next untranslated or fuzzy string"), + "next_untranslated_or_fuzzy" }, + { GPH_KB_PASTE_UNTRANSLATED, "paste-untranslated", + on_kb_paste_untranslated, + N_("Paste original untranslated string to translation"), + "paste_message_as_translation" }, + { GPH_KB_REFLOW, "reflow", + on_kb_reflow, + N_("Reflow the current translation string"), "reflow_translation" }, + { GPH_KB_TOGGLE_FUZZY, "toggle-fuzziness", + on_kb_toggle_fuzziness, + N_("Toggle current translation fuzziness"), "toggle_fuzziness" } +}; + +static void +on_widget_kb_activate (GtkMenuItem *widget, + struct Action *action) +{ + action->callback (action->id); +} + void plugin_init (GeanyData *data) { GeanyKeyGroup *group; + GtkBuilder *builder; + GError *error = NULL; + guint i; + + builder = gtk_builder_new (); + gtk_builder_set_translation_domain (builder, GETTEXT_PACKAGE); + if (! gtk_builder_add_from_file (builder, PKGDATADIR"/pohelper/menus.ui", + &error)) { + g_critical (_("Failed to load UI definition, please check your " + "installation. The error was: %s"), error->message); + g_error_free (error); + g_object_unref (builder); + builder = NULL; + plugin.menu_item = NULL; + } else { + plugin.menu_item = GTK_WIDGET (gtk_builder_get_object (builder, "root_item")); + gtk_menu_shell_append (GTK_MENU_SHELL (geany->main_widgets->tools_menu), + plugin.menu_item); + } + /* signal handlers */ plugin_signal_connect (geany_plugin, NULL, "document-before-save", TRUE, G_CALLBACK (on_document_save), NULL); /* add keybindings */ group = plugin_set_key_group (geany_plugin, "pohelper", GPH_KB_COUNT, NULL); - keybindings_set_item (group, GPH_KB_GOTO_PREV, - on_kb_goto_prev, 0, 0, - "goto-prev", - _("Go to previous string"), - NULL); - keybindings_set_item (group, GPH_KB_GOTO_NEXT, - on_kb_goto_next, 0, 0, - "goto-next", - _("Go to next string"), - NULL); - keybindings_set_item (group, GPH_KB_GOTO_PREV_UNTRANSLATED, - on_kb_goto_prev_untranslated, 0, 0, - "goto-prev-untranslated", - _("Go to previous untranslated string"), - NULL); - keybindings_set_item (group, GPH_KB_GOTO_NEXT_UNTRANSLATED, - on_kb_goto_next_untranslated, 0, 0, - "goto-next-untranslated", - _("Go to next untranslated string"), - NULL); - keybindings_set_item (group, GPH_KB_GOTO_PREV_FUZZY, - on_kb_goto_prev_fuzzy, 0, 0, - "goto-prev-fuzzy", - _("Go to previous fuzzily translated string"), - NULL); - keybindings_set_item (group, GPH_KB_GOTO_NEXT_FUZZY, - on_kb_goto_next_fuzzy, 0, 0, - "goto-next-fuzzy", - _("Go to next fuzzily translated string"), - NULL); - keybindings_set_item (group, GPH_KB_GOTO_PREV_UNTRANSLATED_OR_FUZZY, - on_kb_goto_prev_untranslated_or_fuzzy, 0, 0, - "goto-prev-untranslated-or-fuzzy", - _("Go to previous untranslated or fuzzy string"), - NULL); - keybindings_set_item (group, GPH_KB_GOTO_NEXT_UNTRANSLATED_OR_FUZZY, - on_kb_goto_next_untranslated_or_fuzzy, 0, 0, - "goto-next-untranslated-or-fuzzy", - _("Go to next untranslated or fuzzy string"), - NULL); - keybindings_set_item (group, GPH_KB_PASTE_UNTRANSLATED, - on_kb_paste_untranslated, 0, 0, - "paste-untranslated", - _("Paste original untranslated string to translation"), - NULL); - keybindings_set_item (group, GPH_KB_REFLOW, - on_kb_reflow, 0, 0, - "reflow", - _("Reflow the translated string"), - NULL); - keybindings_set_item (group, GPH_KB_TOGGLE_FUZZY, - on_kb_toggle_fuzziness, 0, 0, - "toggle-fuzziness", - _("Toggle fuzziness of the translated string"), - NULL); + for (i = 0; i < G_N_ELEMENTS (G_actions); i++) { + GtkWidget *widget = NULL; + + if (builder && G_actions[i].widget) { + GObject *obj = gtk_builder_get_object (builder, G_actions[i].widget); + + if (! obj || ! GTK_IS_MENU_ITEM (obj)) { + g_critical (_("Cannot find widget \"%s\" in the UI definition, " + "please check your installation."), G_actions[i].widget); + } else { + widget = GTK_WIDGET (obj); + g_signal_connect (widget, "activate", + G_CALLBACK (on_widget_kb_activate), + (gpointer) &G_actions[i]); + } + } + + keybindings_set_item (group, G_actions[i].id, G_actions[i].callback, 0, 0, + G_actions[i].name, _(G_actions[i].label), widget); + } + + if (builder) { + g_object_unref (builder); + } } void plugin_cleanup (void) { + if (plugin.menu_item) { + gtk_widget_destroy (plugin.menu_item); + } } diff --git a/pohelper/wscript_build b/pohelper/wscript_build index 8d78be3f7..bd84ef0cb 100644 --- a/pohelper/wscript_build +++ b/pohelper/wscript_build @@ -20,7 +20,7 @@ # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. # -from build.wafutils import build_plugin +from build.wafutils import build_plugin, target_is_win32 name = 'PoHelper' @@ -31,3 +31,8 @@ includes = ['src'] build_plugin(bld, name, sources=sources, includes=includes) + +# install UI file +prefix = '${G_PREFIX}/' if target_is_win32(bld) else '' +datadir = '${GEANYPLUGINS_DATADIR}/geany-plugins/%s' % (name.lower()) +bld.install_files('%s%s' % (prefix, datadir), 'data/menus.ui') From c7b5e9422b75f8438d3bafede90680bc3666715a Mon Sep 17 00:00:00 2001 From: Colomban Wendling Date: Wed, 13 Mar 2013 01:06:55 +0100 Subject: [PATCH 7/7] pohelper: Add a setting to choose whether to update headers on save --- pohelper/data/menus.ui | 16 ++++ pohelper/src/gph-plugin.c | 160 +++++++++++++++++++++++++++++++------- 2 files changed, 147 insertions(+), 29 deletions(-) diff --git a/pohelper/data/menus.ui b/pohelper/data/menus.ui index 86b3f9c10..4bdc8e6be 100644 --- a/pohelper/data/menus.ui +++ b/pohelper/data/menus.ui @@ -217,6 +217,22 @@ True + + + True + False + + + + + False + True + False + Whether to update the translation headers (author, revision date, ...) upon file save + Update _Headers Upon Save + True + + diff --git a/pohelper/src/gph-plugin.c b/pohelper/src/gph-plugin.c index 0b0f90594..d3d0d02fe 100644 --- a/pohelper/src/gph-plugin.c +++ b/pohelper/src/gph-plugin.c @@ -17,11 +17,6 @@ * */ -/* - * TODO: - * * allow to configure whether to update the metadata upon save - */ - #include "config.h" #include @@ -67,8 +62,13 @@ enum { static struct Plugin { + gboolean update_headers; + GtkWidget *menu_item; -} plugin; +} plugin = { + TRUE, + NULL +}; #define doc_is_po(doc) (DOC_VALID (doc) && \ @@ -448,30 +448,26 @@ on_document_save (GObject *obj, GeanyDocument *doc, gpointer user_data) { - if (doc_is_po (doc)) { - gboolean update_header = TRUE; /* FIXME: make this configurable */ + if (doc_is_po (doc) && plugin.update_headers) { + gchar *name = escape_string (geany_data->template_prefs->developer); + gchar *mail = escape_string (geany_data->template_prefs->mail); + gchar *date; + gchar *translator; - if (update_header) { - gchar *name = escape_string (geany_data->template_prefs->developer); - gchar *mail = escape_string (geany_data->template_prefs->mail); - gchar *date; - gchar *translator; - - date = utils_get_date_time ("\"PO-Revision-Date: %Y-%m-%d %H:%M%z\\n\"", - NULL); - translator = g_strdup_printf ("\"Last-Translator: %s <%s>\\n\"", - name, mail); - - sci_start_undo_action (doc->editor->sci); - regex_replace (doc->editor->sci, "^\"PO-Revision-Date: .*\"$", date); - regex_replace (doc->editor->sci, "^\"Last-Translator: .*\"$", translator); - sci_end_undo_action (doc->editor->sci); - - g_free (date); - g_free (translator); - g_free (name); - g_free (mail); - } + date = utils_get_date_time ("\"PO-Revision-Date: %Y-%m-%d %H:%M%z\\n\"", + NULL); + translator = g_strdup_printf ("\"Last-Translator: %s <%s>\\n\"", + name, mail); + + sci_start_undo_action (doc->editor->sci); + regex_replace (doc->editor->sci, "^\"PO-Revision-Date: .*\"$", date); + regex_replace (doc->editor->sci, "^\"Last-Translator: .*\"$", translator); + sci_end_undo_action (doc->editor->sci); + + g_free (date); + g_free (translator); + g_free (name); + g_free (mail); } } @@ -1016,6 +1012,100 @@ on_widget_kb_activate (GtkMenuItem *widget, action->callback (action->id); } +static void +on_update_headers_upon_save_toggled (GtkCheckMenuItem *item, + gpointer data) +{ + plugin.update_headers = gtk_check_menu_item_get_active (item); +} + +static gchar * +get_config_filename (void) +{ + return g_build_filename (geany_data->app->configdir, "plugins", + "pohelper", "pohelper.conf", NULL); +} + +/* loads @filename in @kf and return %FALSE if failed, emitting a warning + * unless the file was simply missing */ +static gboolean +load_keyfile (GKeyFile *kf, + const gchar *filename, + GKeyFileFlags flags) +{ + GError *error = NULL; + + if (! g_key_file_load_from_file (kf, filename, flags, &error)) { + if (error->domain != G_FILE_ERROR || error->code != G_FILE_ERROR_NOENT) { + g_warning (_("Failed to load configuration file: %s"), error->message); + } + g_error_free (error); + + return FALSE; + } + + return TRUE; +} + +/* writes @kf in @filename, possibly creating directories to be able to write + * in @filename */ +static gboolean +write_keyfile (GKeyFile *kf, + const gchar *filename) +{ + gchar *dirname = g_path_get_dirname (filename); + GError *error = NULL; + gint err; + gchar *data; + gsize length; + gboolean success = FALSE; + + data = g_key_file_to_data (kf, &length, NULL); + if ((err = utils_mkdir (dirname, TRUE)) != 0) { + g_critical (_("Failed to create configuration directory \"%s\": %s"), + dirname, g_strerror (err)); + } else if (! g_file_set_contents (filename, data, (gssize) length, &error)) { + g_critical (_("Failed to save configuration file: %s"), error->message); + g_error_free (error); + } else { + success = TRUE; + } + g_free (data); + g_free (dirname); + + return success; +} + +static void +load_config (void) +{ + gchar *filename = get_config_filename (); + GKeyFile *kf = g_key_file_new (); + + if (load_keyfile (kf, filename, G_KEY_FILE_NONE)) { + plugin.update_headers = utils_get_setting_boolean (kf, "general", + "update-headers", + plugin.update_headers); + } + g_key_file_free (kf); + g_free (filename); +} + +static void +save_config (void) +{ + gchar *filename = get_config_filename (); + GKeyFile *kf = g_key_file_new (); + + load_keyfile (kf, filename, G_KEY_FILE_KEEP_COMMENTS); + g_key_file_set_boolean (kf, "general", "update-headers", + plugin.update_headers); + write_keyfile (kf, filename); + + g_key_file_free (kf); + g_free (filename); +} + void plugin_init (GeanyData *data) { @@ -1024,6 +1114,8 @@ plugin_init (GeanyData *data) GError *error = NULL; guint i; + load_config (); + builder = gtk_builder_new (); gtk_builder_set_translation_domain (builder, GETTEXT_PACKAGE); if (! gtk_builder_add_from_file (builder, PKGDATADIR"/pohelper/menus.ui", @@ -1035,9 +1127,17 @@ plugin_init (GeanyData *data) builder = NULL; plugin.menu_item = NULL; } else { + GObject *obj; + plugin.menu_item = GTK_WIDGET (gtk_builder_get_object (builder, "root_item")); gtk_menu_shell_append (GTK_MENU_SHELL (geany->main_widgets->tools_menu), plugin.menu_item); + + obj = gtk_builder_get_object (builder, "update_headers_upon_save"); + gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (obj), + plugin.update_headers); + g_signal_connect (obj, "toggled", + G_CALLBACK (on_update_headers_upon_save_toggled), NULL); } /* signal handlers */ @@ -1079,4 +1179,6 @@ plugin_cleanup (void) if (plugin.menu_item) { gtk_widget_destroy (plugin.menu_item); } + + save_config (); }