Revision: 1252 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1252&view=re... Author: colombanw Date: 2010-04-18 02:13:07 +0000 (Sun, 18 Apr 2010)
Log Message: ----------- GeanyGenDoc: Initial commit of the plugin
Added Paths: ----------- trunk/geanygendoc/ trunk/geanygendoc/AUTHORS trunk/geanygendoc/COPYING trunk/geanygendoc/INSTALL trunk/geanygendoc/Makefile.am trunk/geanygendoc/README.in trunk/geanygendoc/TODO trunk/geanygendoc/autogen.sh trunk/geanygendoc/configure.ac trunk/geanygendoc/data/ trunk/geanygendoc/data/Makefile.am trunk/geanygendoc/data/filetypes/ trunk/geanygendoc/data/filetypes/Makefile.am trunk/geanygendoc/data/filetypes/c.conf trunk/geanygendoc/po/ trunk/geanygendoc/po/LINGUAS trunk/geanygendoc/po/POTFILES.in trunk/geanygendoc/po/fr.po trunk/geanygendoc/src/ trunk/geanygendoc/src/Makefile.am trunk/geanygendoc/src/ggd-doc-setting.c trunk/geanygendoc/src/ggd-doc-setting.h trunk/geanygendoc/src/ggd-doc-type.c trunk/geanygendoc/src/ggd-doc-type.h trunk/geanygendoc/src/ggd-file-type-loader.c trunk/geanygendoc/src/ggd-file-type-loader.h trunk/geanygendoc/src/ggd-file-type-manager.c trunk/geanygendoc/src/ggd-file-type-manager.h trunk/geanygendoc/src/ggd-file-type.c trunk/geanygendoc/src/ggd-file-type.h trunk/geanygendoc/src/ggd-options.c trunk/geanygendoc/src/ggd-options.h trunk/geanygendoc/src/ggd-plugin.c trunk/geanygendoc/src/ggd-plugin.h trunk/geanygendoc/src/ggd-tag-utils.c trunk/geanygendoc/src/ggd-tag-utils.h trunk/geanygendoc/src/ggd-utils.c trunk/geanygendoc/src/ggd-utils.h trunk/geanygendoc/src/ggd.c trunk/geanygendoc/src/ggd.h
Added: trunk/geanygendoc/AUTHORS =================================================================== --- trunk/geanygendoc/AUTHORS (rev 0) +++ trunk/geanygendoc/AUTHORS 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1 @@ +Colomban Wendling ban@herbesfolles.org
Added: trunk/geanygendoc/COPYING =================================================================== --- trunk/geanygendoc/COPYING (rev 0) +++ trunk/geanygendoc/COPYING 2010-04-18 02:13:07 UTC (rev 1252) @@ -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: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +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.
Added: trunk/geanygendoc/INSTALL =================================================================== --- trunk/geanygendoc/INSTALL (rev 0) +++ trunk/geanygendoc/INSTALL 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,365 @@ +Installation Instructions +************************* + +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, +2006, 2007, 2008, 2009 Free Software Foundation, Inc. + + Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. This file is offered as-is, +without warranty of any kind. + +Basic Installation +================== + + Briefly, the shell commands `./configure; make; make install' should +configure, build, and install this package. The following +more-detailed instructions are generic; see the `README' file for +instructions specific to this package. Some packages provide this +`INSTALL' file but do not implement all of the features documented +below. The lack of an optional feature in a given package is not +necessarily a bug. More recommendations for GNU packages can be found +in *note Makefile Conventions: (standards)Makefile Conventions. + + The `configure' shell script attempts to guess correct values for +various system-dependent variables used during compilation. It uses +those values to create a `Makefile' in each directory of the package. +It may also create one or more `.h' files containing system-dependent +definitions. Finally, it creates a shell script `config.status' that +you can run in the future to recreate the current configuration, and a +file `config.log' containing compiler output (useful mainly for +debugging `configure'). + + It can also use an optional file (typically called `config.cache' +and enabled with `--cache-file=config.cache' or simply `-C') that saves +the results of its tests to speed up reconfiguring. Caching is +disabled by default to prevent problems with accidental use of stale +cache files. + + If you need to do unusual things to compile the package, please try +to figure out how `configure' could check whether to do them, and mail +diffs or instructions to the address given in the `README' so they can +be considered for the next release. If you are using the cache, and at +some point `config.cache' contains results you don't want to keep, you +may remove or edit it. + + The file `configure.ac' (or `configure.in') is used to create +`configure' by a program called `autoconf'. You need `configure.ac' if +you want to change it or regenerate `configure' using a newer version +of `autoconf'. + + The simplest way to compile this package is: + + 1. `cd' to the directory containing the package's source code and type + `./configure' to configure the package for your system. + + Running `configure' might take a while. While running, it prints + some messages telling which features it is checking for. + + 2. Type `make' to compile the package. + + 3. Optionally, type `make check' to run any self-tests that come with + the package, generally using the just-built uninstalled binaries. + + 4. Type `make install' to install the programs and any data files and + documentation. When installing into a prefix owned by root, it is + recommended that the package be configured and built as a regular + user, and only the `make install' phase executed with root + privileges. + + 5. Optionally, type `make installcheck' to repeat any self-tests, but + this time using the binaries in their final installed location. + This target does not install anything. Running this target as a + regular user, particularly if the prior `make install' required + root privileges, verifies that the installation completed + correctly. + + 6. You can remove the program binaries and object files from the + source code directory by typing `make clean'. To also remove the + files that `configure' created (so you can compile the package for + a different kind of computer), type `make distclean'. There is + also a `make maintainer-clean' target, but that is intended mainly + for the package's developers. If you use it, you may have to get + all sorts of other programs in order to regenerate files that came + with the distribution. + + 7. Often, you can also type `make uninstall' to remove the installed + files again. In practice, not all packages have tested that + uninstallation works correctly, even though it is required by the + GNU Coding Standards. + + 8. Some packages, particularly those that use Automake, provide `make + distcheck', which can by used by developers to test that all other + targets like `make install' and `make uninstall' work correctly. + This target is generally not run by end users. + +Compilers and Options +===================== + + Some systems require unusual options for compilation or linking that +the `configure' script does not know about. Run `./configure --help' +for details on some of the pertinent environment variables. + + You can give `configure' initial values for configuration parameters +by setting variables in the command line or in the environment. Here +is an example: + + ./configure CC=c99 CFLAGS=-g LIBS=-lposix + + *Note Defining Variables::, for more details. + +Compiling For Multiple Architectures +==================================== + + You can compile the package for more than one kind of computer at the +same time, by placing the object files for each architecture in their +own directory. To do this, you can use GNU `make'. `cd' to the +directory where you want the object files and executables to go and run +the `configure' script. `configure' automatically checks for the +source code in the directory that `configure' is in and in `..'. This +is known as a "VPATH" build. + + With a non-GNU `make', it is safer to compile the package for one +architecture at a time in the source code directory. After you have +installed the package for one architecture, use `make distclean' before +reconfiguring for another architecture. + + On MacOS X 10.5 and later systems, you can create libraries and +executables that work on multiple system types--known as "fat" or +"universal" binaries--by specifying multiple `-arch' options to the +compiler but only a single `-arch' option to the preprocessor. Like +this: + + ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ + CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ + CPP="gcc -E" CXXCPP="g++ -E" + + This is not guaranteed to produce working output in all cases, you +may have to build one architecture at a time and combine the results +using the `lipo' tool if you have problems. + +Installation Names +================== + + By default, `make install' installs the package's commands under +`/usr/local/bin', include files under `/usr/local/include', etc. You +can specify an installation prefix other than `/usr/local' by giving +`configure' the option `--prefix=PREFIX', where PREFIX must be an +absolute file name. + + You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. If you +pass the option `--exec-prefix=PREFIX' to `configure', the package uses +PREFIX as the prefix for installing programs and libraries. +Documentation and other data files still use the regular prefix. + + In addition, if you use an unusual directory layout you can give +options like `--bindir=DIR' to specify different values for particular +kinds of files. Run `configure --help' for a list of the directories +you can set and what kinds of files go in them. In general, the +default for these options is expressed in terms of `${prefix}', so that +specifying just `--prefix' will affect all of the other directory +specifications that were not explicitly provided. + + The most portable way to affect installation locations is to pass the +correct locations to `configure'; however, many packages provide one or +both of the following shortcuts of passing variable assignments to the +`make install' command line to change installation locations without +having to reconfigure or recompile. + + The first method involves providing an override variable for each +affected directory. For example, `make install +prefix=/alternate/directory' will choose an alternate location for all +directory configuration variables that were expressed in terms of +`${prefix}'. Any directories that were specified during `configure', +but not in terms of `${prefix}', must each be overridden at install +time for the entire installation to be relocated. The approach of +makefile variable overrides for each directory variable is required by +the GNU Coding Standards, and ideally causes no recompilation. +However, some platforms have known limitations with the semantics of +shared libraries that end up requiring recompilation when using this +method, particularly noticeable in packages that use GNU Libtool. + + The second method involves providing the `DESTDIR' variable. For +example, `make install DESTDIR=/alternate/directory' will prepend +`/alternate/directory' before all installation names. The approach of +`DESTDIR' overrides is not required by the GNU Coding Standards, and +does not work on platforms that have drive letters. On the other hand, +it does better at avoiding recompilation issues, and works well even +when some directory options were not specified in terms of `${prefix}' +at `configure' time. + +Optional Features +================= + + If the package supports it, you can cause programs to be installed +with an extra prefix or suffix on their names by giving `configure' the +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. + + Some packages pay attention to `--enable-FEATURE' options to +`configure', where FEATURE indicates an optional part of the package. +They may also pay attention to `--with-PACKAGE' options, where PACKAGE +is something like `gnu-as' or `x' (for the X Window System). The +`README' should mention any `--enable-' and `--with-' options that the +package recognizes. + + For packages that use the X Window System, `configure' can usually +find the X include and library files automatically, but if it doesn't, +you can use the `configure' options `--x-includes=DIR' and +`--x-libraries=DIR' to specify their locations. + + Some packages offer the ability to configure how verbose the +execution of `make' will be. For these packages, running `./configure +--enable-silent-rules' sets the default to minimal output, which can be +overridden with `make V=1'; while running `./configure +--disable-silent-rules' sets the default to verbose, which can be +overridden with `make V=0'. + +Particular systems +================== + + On HP-UX, the default C compiler is not ANSI C compatible. If GNU +CC is not installed, it is recommended to use the following options in +order to use an ANSI C compiler: + + ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" + +and if that doesn't work, install pre-built binaries of GCC for HP-UX. + + On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot +parse its `<wchar.h>' header file. The option `-nodtk' can be used as +a workaround. If GNU CC is not installed, it is therefore recommended +to try + + ./configure CC="cc" + +and if that doesn't work, try + + ./configure CC="cc -nodtk" + + On Solaris, don't put `/usr/ucb' early in your `PATH'. This +directory contains several dysfunctional programs; working variants of +these programs are available in `/usr/bin'. So, if you need `/usr/ucb' +in your `PATH', put it _after_ `/usr/bin'. + + On Haiku, software installed for all users goes in `/boot/common', +not `/usr/local'. It is recommended to use the following options: + + ./configure --prefix=/boot/common + +Specifying the System Type +========================== + + There may be some features `configure' cannot figure out +automatically, but needs to determine by the type of machine the package +will run on. Usually, assuming the package is built to be run on the +_same_ architectures, `configure' can figure that out, but if it prints +a message saying it cannot guess the machine type, give it the +`--build=TYPE' option. TYPE can either be a short name for the system +type, such as `sun4', or a canonical name which has the form: + + CPU-COMPANY-SYSTEM + +where SYSTEM can have one of these forms: + + OS + KERNEL-OS + + See the file `config.sub' for the possible values of each field. If +`config.sub' isn't included in this package, then this package doesn't +need to know the machine type. + + If you are _building_ compiler tools for cross-compiling, you should +use the option `--target=TYPE' to select the type of system they will +produce code for. + + If you want to _use_ a cross compiler, that generates code for a +platform different from the build platform, you should specify the +"host" platform (i.e., that on which the generated programs will +eventually be run) with `--host=TYPE'. + +Sharing Defaults +================ + + If you want to set default values for `configure' scripts to share, +you can create a site shell script called `config.site' that gives +default values for variables like `CC', `cache_file', and `prefix'. +`configure' looks for `PREFIX/share/config.site' if it exists, then +`PREFIX/etc/config.site' if it exists. Or, you can set the +`CONFIG_SITE' environment variable to the location of the site script. +A warning: not all `configure' scripts look for a site script. + +Defining Variables +================== + + Variables not defined in a site shell script can be set in the +environment passed to `configure'. However, some packages may run +configure again during the build, and the customized values of these +variables may be lost. In order to avoid this problem, you should set +them in the `configure' command line, using `VAR=value'. For example: + + ./configure CC=/usr/local2/bin/gcc + +causes the specified `gcc' to be used as the C compiler (unless it is +overridden in the site shell script). + +Unfortunately, this technique does not work for `CONFIG_SHELL' due to +an Autoconf bug. Until the bug is fixed you can use this workaround: + + CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash + +`configure' Invocation +====================== + + `configure' recognizes the following options to control how it +operates. + +`--help' +`-h' + Print a summary of all of the options to `configure', and exit. + +`--help=short' +`--help=recursive' + Print a summary of the options unique to this package's + `configure', and exit. The `short' variant lists options used + only in the top level, while the `recursive' variant lists options + also present in any nested packages. + +`--version' +`-V' + Print the version of Autoconf used to generate the `configure' + script, and exit. + +`--cache-file=FILE' + Enable the cache: use and save the results of the tests in FILE, + traditionally `config.cache'. FILE defaults to `/dev/null' to + disable caching. + +`--config-cache' +`-C' + Alias for `--cache-file=config.cache'. + +`--quiet' +`--silent' +`-q' + Do not print messages saying which checks are being made. To + suppress all normal output, redirect it to `/dev/null' (any error + messages will still be shown). + +`--srcdir=DIR' + Look for the package's source code in directory DIR. Usually + `configure' can determine that directory automatically. + +`--prefix=DIR' + Use DIR as the installation prefix. *note Installation Names:: + for more details, including other options available for fine-tuning + the installation locations. + +`--no-create' +`-n' + Run the configure checks, but stop before creating any output + files. + +`configure' also accepts some other, not widely useful, options. Run +`configure --help' for more details. +
Added: trunk/geanygendoc/Makefile.am =================================================================== --- trunk/geanygendoc/Makefile.am (rev 0) +++ trunk/geanygendoc/Makefile.am 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,14 @@ + +SUBDIRS = src data po + +ACLOCAL_AMFLAGS = -I build/m4 + +EXTRA_DIST = autogen.sh \ + README \ + po/LINGUAS + +sign: + if test -f $(PACKAGE)-$(VERSION).tar.gz; then \ + gpg --detach-sign --digest-algo SHA512 $(PACKAGE)-$(VERSION).tar.gz; fi + if test -f $(PACKAGE)-$(VERSION).tar.bz2; then \ + gpg --detach-sign --digest-algo SHA512 $(PACKAGE)-$(VERSION).tar.bz2; fi
Added: trunk/geanygendoc/README.in =================================================================== --- trunk/geanygendoc/README.in (rev 0) +++ trunk/geanygendoc/README.in 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,33 @@ +General Information +=================== + +This is GeanyGenDoc @VERSION@, a plugin for Geany that aims to automatically +generate documentation comment basis from the source code. + +Requirements +============ + +You will need the following packages to build GeanyGenDoc: + - Geany >= 0.19 (http://www.geany.org/) + - GTK+ >= 2.12 (http://www.gtk.org) + - GLib >= 2.14 (http://www.gtk.org) + - GIO >= 2.18 (http://www.gtk.org) + - CTPL >= 0.2 (http://ctpl.tuxfamily.org/) + - A working C compiler (GCC for example, http://gcc.gnu.org/) + - A working make implementation (GNU make is recommended, + http://www.gnu.org/software/make/) + + +Installation +============ + +Compiling and installing the plugin is done by the following commands: + + $ ./configure + $ make + $ make install + +For more configuration details run + $ ./configure --help + +For detailed instructions, see the INSTALL file.
Added: trunk/geanygendoc/TODO =================================================================== --- trunk/geanygendoc/TODO (rev 0) +++ trunk/geanygendoc/TODO 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,17 @@ +* support setting duplication in filetype configuration + function = { + template = "my template"; + # more settings... + } + prototype = function; + macro = function; + This would be really convenient with function, macro and prototypes for + example. + +* Support doctype-specific user-defined environment chunks. + Problem: there is (for now) nothing here for this kind of settings + (doctype-global but also specific to it). + +* Provide convenient action "document all file" which would document each and + every thing in teh current file. Needs a lot of care because of FORWARD + policies but should be doable (and pretty cool).
Added: trunk/geanygendoc/autogen.sh =================================================================== --- trunk/geanygendoc/autogen.sh (rev 0) +++ trunk/geanygendoc/autogen.sh 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,8 @@ +#!/bin/sh + + +mkdir -p build/aux || exit 1 +mkdir -p build/m4 || exit 1 +#~ gtkdocize --flavour no-tmpl || exit 1 +glib-gettextize -c -f || exit 1 +autoreconf -vfi || exit 1
Property changes on: trunk/geanygendoc/autogen.sh ___________________________________________________________________ Added: svn:executable + *
Added: trunk/geanygendoc/configure.ac =================================================================== --- trunk/geanygendoc/configure.ac (rev 0) +++ trunk/geanygendoc/configure.ac 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,80 @@ +# Process this file with autoconf to produce a configure script. + +AC_PREREQ([2.64]) +AC_INIT([geanygendoc], + [0.1], + [ban@herbesfolles.org], + [geanygendoc]) +AC_CONFIG_SRCDIR([src/ggd.c]) +AC_CONFIG_AUX_DIR([build/aux]) +AC_CONFIG_MACRO_DIR([build/m4]) +AM_INIT_AUTOMAKE([1.11.1 -Wall -Werror foreign]) +AC_CONFIG_HEADERS([config.h]) + +m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) + +AC_PROG_CC +LT_PREREQ([2.2.0]) +LT_INIT([disable-static]) +AC_PROG_INSTALL + +# checking for Geany +PKG_CHECK_MODULES(GEANY, [geany >= 0.19]) +PKG_CHECK_MODULES(GTK, [gtk+-2.0 >= 2.12]) +PKG_CHECK_MODULES(GLIB, [glib-2.0 >= 2.14]) +# need GIO >= 2.18 for g_memory_output_stream_get_data_size() +PKG_CHECK_MODULES(GIO, [gio-2.0 >= 2.18]) +PKG_CHECK_MODULES(CTPL, [ctpl >= 0.2]) + +GEANY_VERSION=`$PKG_CONFIG --modversion geany` +GTK_VERSION=`$PKG_CONFIG --modversion gtk+-2.0` +GLIB_VERSION=`$PKG_CONFIG --modversion glib-2.0` +GIO_VERSION=`$PKG_CONFIG --modversion gio-2.0` +CTPL_VERSION=`$PKG_CONFIG --modversion ctpl` + +# i18n +GETTEXT_PACKAGE=geanygendoc +AC_SUBST(GETTEXT_PACKAGE) +AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE, "$GETTEXT_PACKAGE", [Gettext package.]) + +ALL_LINGUAS="`sed -e '/^#/d' $srcdir/po/LINGUAS`" # take all languages found in file po/LINGUAS + +AM_GLIB_GNU_GETTEXT +# workaround for intltool bug (http://bugzilla.gnome.org/show_bug.cgi?id=490845) +if test "x$MSGFMT" = "xno"; then + AC_MSG_ERROR([msgfmt not found. Please install the gettext package.]) +fi + +# intltool hack to define install_sh on Debian/Ubuntu systems +if test "x$install_sh" = "x"; then + install_sh="`pwd`/install-sh" + AC_SUBST(install_sh) +fi + +# get the plugin installed at the correct location for Geany +# TODO find a way to NOT override --libdir command line option if given +libdir="`$PKG_CONFIG --variable=libdir geany`/geany" +# same for the data, since we use geany->app->datadir +plugindatadir="`$PKG_CONFIG --variable=datadir geany`/geany/${PACKAGE_TARNAME}" +AC_SUBST([plugindatadir]) + + +AC_CONFIG_FILES([ + README + Makefile + src/Makefile + data/Makefile + data/filetypes/Makefile + po/Makefile.in +]) +AC_OUTPUT + +echo "----------------------------------------" +echo "Using Geany version : ${GEANY_VERSION}" +echo "Using GLib version : ${GLIB_VERSION}" +echo "Using GIO version : ${GIO_VERSION}" +echo "Using GTK version : ${GTK_VERSION}" +echo "Using CTPL version : ${CTPL_VERSION}" +echo "" +echo "Configuration is done OK." +echo ""
Added: trunk/geanygendoc/data/Makefile.am =================================================================== --- trunk/geanygendoc/data/Makefile.am (rev 0) +++ trunk/geanygendoc/data/Makefile.am 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1 @@ +SUBDIRS = filetypes
Added: trunk/geanygendoc/data/filetypes/Makefile.am =================================================================== --- trunk/geanygendoc/data/filetypes/Makefile.am (rev 0) +++ trunk/geanygendoc/data/filetypes/Makefile.am 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,4 @@ +filetypesdir = $(plugindatadir)/filetypes +filetypes_DATA = c.conf + +EXTRA_DIST = $(filetypes_DATA)
Added: trunk/geanygendoc/data/filetypes/c.conf =================================================================== --- trunk/geanygendoc/data/filetypes/c.conf (rev 0) +++ trunk/geanygendoc/data/filetypes/c.conf 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,92 @@ + +settings = { + # [[modifier ]type ]arg[square brackets, white spaces, ...](,|EOL) with support + # of prototype as argument types (not recursive). + # + # Detailed expression: + #function_args=(?: + # matches (void) not to try to extract an argument for it + # ^([ \t]*void[ \t]*)$ + # | + # type or modifier (e.g. "char *") + # (?:[a-zA-Z0-9_]+[ \t*]+ + # prototype start (e.g. "(*", start of (*arg)) + # (?:([ \t*]*)?)* + # the argument name itself (only capture) + # ([a-zA-Z0-9_.]+) + # prototype end (e.g. ")", end of (*arg)) + # (?:[ \t]*))? + # possible white-spaces + # [ \t]* + # prototype arguments: we match anything between parentheses + # (?:([^)]*))? + # permissive match for post-arg (e.g. array size) + # [^,]* + # , or EOL + # (?:,|$) + # ) + # note that \ are escaped, so to have a \ you need to put \ + match_function_arguments = "(?:^\([ \t]*void[ \t]*\)$|(?:[a-zA-Z0-9_]+[ \t*]+(?:\([ \t*]*)?)*([a-zA-Z0-9_.]+)(?:[ \t]*\))?[ \t]*(?:\([^)]*\))?[^,]*(?:,|$))"; + + # global env + global_environment = "doxygen_prefix = "@"; + write_since = 1;"; +} + +doctypes = { + gtkdoc = { + # Forward should be before the others to match first + struct.struct.policy = FORWARD; + struct.union.policy = FORWARD; + struct.prototype.policy = FORWARD; + member.policy = FORWARD; + enumval.policy = FORWARD; + + function = { + template = "/**\n * {symbol}:\n{for arg in argument_list} * @{arg}: \n{end} * \n * \n{if returns} * \n * Returns: \n{end}{if write_since}{if returns} * \n{end} * Since: \n{end} */\n"; + position = BEFORE; + policy = KEEP; + } + prototype = { + template = "/**\n * {symbol}:\n{for arg in argument_list} * @{arg}: \n{end} * \n * \n{if returns} * \n * Returns: \n{end} */\n"; + } + macro = { + template = "/**\n * {symbol}:\n{for arg in argument_list} * @{arg}: \n{end} * \n * \n{if returns} * \n * Returns: \n{end} */\n"; + } + struct = { + template = "/**\n * {symbol}:\n{for member in children} * @{member}: \n{end} * \n * \n */\n"; + position = BEFORE; + policy = KEEP; + children = MERGE; + matches = member | prototype; + } + enum = { + template = "/**\n * {symbol}:\n{for enumval in enumval_list} * @{enumval}: \n{end} * \n * \n */\n"; + } + union = { + # FIXME: fill-in + } + typedef = { + template = "/**\n * {symbol}:\n * \n * \n */\n"; + } + } + + doxygen = { + function = { + template = "/**\n{for a in argument_list} * {doxygen_prefix}param {a} \n{end}{if returns} * {doxygen_prefix}returns \n{end}{if write_since} * {doxygen_prefix}since \n{end} * \n * \n */\n"; + position = BEFORE; + policy = KEEP; + } + + struct.member = { + template = " /**< */"; + position = AFTER; + } + struct = { + template = "/**\n * \n */\n"; + position = BEFORE; + policy = KEEP; + } + } +} +
Added: trunk/geanygendoc/po/LINGUAS =================================================================== --- trunk/geanygendoc/po/LINGUAS (rev 0) +++ trunk/geanygendoc/po/LINGUAS 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1 @@ +fr
Added: trunk/geanygendoc/po/POTFILES.in =================================================================== --- trunk/geanygendoc/po/POTFILES.in (rev 0) +++ trunk/geanygendoc/po/POTFILES.in 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,9 @@ +src/ggd.c +src/ggd-doc-setting.c +src/ggd-doc-type.c +src/ggd-file-type.c +src/ggd-file-type-loader.c +src/ggd-file-type-manager.c +src/ggd-options.c +src/ggd-plugin.c +src/ggd-utils.c
Added: trunk/geanygendoc/po/fr.po =================================================================== --- trunk/geanygendoc/po/fr.po (rev 0) +++ trunk/geanygendoc/po/fr.po 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,280 @@ +# French translations for geanygendoc package +# Traductions françaises du paquet geanygendoc. +# Copyright (C) 2010 THE geanygendoc'S COPYRIGHT HOLDER +# This file is distributed under the same license as the geanygendoc package. +# Colomban Wendling ban@herbesfolles.org, 2010. +# +msgid "" +msgstr "" +"Project-Id-Version: geanygendoc 0.0.1\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2010-04-16 01:06+0200\n" +"PO-Revision-Date: 2010-04-16 00:38+0200\n" +"Last-Translator: Colomban Wendling ban@herbesfolles.org\n" +"Language-Team: French\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" + +#: src/ggd.c:63 +#, c-format +msgid "Failed to resize memory output stream" +msgstr "Impossible de redimensionner le flux de sortie mémoire" + +#: src/ggd.c:89 +#, c-format +msgid "" +"Argument parsing regular expression did not match (argument list was: "%s")" +msgstr "" +"L'expression régulière d'analyse des arguments n'a pas correspondu (la liste " +"d'arguments était : « %s »)" + +#: src/ggd.c:220 +#, c-format +msgid "Failed to build comment: %s" +msgstr "Impossible de construire le commentaire : %s" + +#: src/ggd.c:370 +#, c-format +msgid "No valid tag for line %d" +msgstr "Pas de tag valide pour la ligne %d" + +#: src/ggd.c:380 +#, c-format +msgid "No documentation type "%s" for language "%s"" +msgstr "Pas de type de documentation « %s » pour le langage « %s »" + +#: src/ggd-file-type-loader.c:115 +#, c-format +msgid "invalid template: %s" +msgstr "modèle invalide : %s" + +#: src/ggd-file-type-loader.c:136 +msgid "position name" +msgstr "nom de position" + +#: src/ggd-file-type-loader.c:143 +#, c-format +msgid "invalid position "%s"" +msgstr "la position « %s » est invalide" + +#: src/ggd-file-type-loader.c:162 +msgid "policy name" +msgstr "nom de politique" + +#: src/ggd-file-type-loader.c:169 +#, c-format +msgid "invalid policy "%s"" +msgstr "la politique « %s » est invalide" + +#: src/ggd-file-type-loader.c:188 +msgid "merge policy" +msgstr "politique de fusion" + +#: src/ggd-file-type-loader.c:195 +#, c-format +msgid "invalid merge policy "%s"" +msgstr "la politique de fusion « %s » est invalide" + +#: src/ggd-file-type-loader.c:217 +msgid "type" +msgstr "type" + +#: src/ggd-file-type-loader.c:224 +#, c-format +msgid "invalid type "%s"" +msgstr "le type « %s » est invalide" + +#: src/ggd-file-type-loader.c:277 src/ggd-file-type-loader.c:725 +#, c-format +msgid "invalid setting name "%s"" +msgstr "" + +#: src/ggd-file-type-loader.c:298 src/ggd-file-type-loader.c:309 +#: src/ggd-file-type-loader.c:334 +msgid "setting identifier" +msgstr "" + +#: src/ggd-file-type-loader.c:380 +#, c-format +msgid "Unknown type "%s". Is this a typo?" +msgstr "Le type « %s » est inconnu. Est-ce une faute de frappe ?" + +#: src/ggd-file-type-loader.c:395 src/ggd-file-type-loader.c:439 +#: src/ggd-file-type-loader.c:451 src/ggd-file-type-loader.c:489 +msgid "match identifier" +msgstr "identifiant de correspondance" + +#: src/ggd-file-type-loader.c:403 +#, c-format +msgid "match is empty" +msgstr "la correspondance est vide" + +#: src/ggd-file-type-loader.c:421 +msgid "documentation type identifier" +msgstr "identifiant de type de documentation" + +#: src/ggd-file-type-loader.c:525 src/ggd-file-type-loader.c:536 +#: src/ggd-file-type-loader.c:557 +msgid "doctype" +msgstr "type de documentation" + +#: src/ggd-file-type-loader.c:591 +#, c-format +msgid "invalid regular expression: %s" +msgstr "expression régulière invalide : %s" + +#: src/ggd-file-type-loader.c:648 +#, c-format +msgid "invalid environment description: %s" +msgstr "description d'environnement invalide : %s" + +#: src/ggd-file-type-loader.c:685 src/ggd-file-type-loader.c:696 +#: src/ggd-file-type-loader.c:735 +msgid "setting" +msgstr "" + +#: src/ggd-file-type-loader.c:763 +msgid "section name" +msgstr "nom de section" + +#: src/ggd-file-type-loader.c:774 +#, c-format +msgid "duplicated section "%s"" +msgstr "la section « %s » est dupliquée" + +#: src/ggd-file-type-loader.c:783 +#, c-format +msgid "invalid section name "%s"" +msgstr "le nom de section « %s » est invalide" + +#: src/ggd-file-type-loader.c:796 src/ggd-file-type-loader.c:848 +#, c-format +msgid "input is empty" +msgstr "l'entrée est vide" + +#: src/ggd-file-type-loader.c:810 +#, c-format +msgid "Parsing warning: %s:%u:%u: %s" +msgstr "Avertissement d'analyse : %s:%u:%u : %s" + +#: src/ggd-file-type-loader.c:813 +#, c-format +msgid "Parsing error: %s:%u:%u: %s" +msgstr "Erreur d'analyse : %s:%u:%u : %s" + +#: src/ggd-file-type-loader.c:817 +#, c-format +msgid "%s:%u:%u: %s" +msgstr "%s:%u:%u : %s" + +#: src/ggd-file-type-manager.c:111 +#, c-format +msgid "Filetype configuration file for language "%s" not found: %s" +msgstr "" +"Le fichier de configuration du type de fichier pour le langage « %s » n'a pas " +"été trouvé : %s" + +#: src/ggd-file-type-manager.c:118 +#, c-format +msgid "Failed to load file type "%s" from file "%s": %s" +msgstr "" +"Impossible de charger le type de fichier « %s » depuis le fichier « %s » : %s" + +#: src/ggd-options.c:290 +msgid "Unknown setting" +msgstr "" + +#: src/ggd-options.c:299 +msgid "" +"Invalid option or proxy: either the proxy's property or the option type is " +"incompatible." +msgstr "" +"Option ou proxy invalide : la propriété du proxy ou le type de l'option est " +"incompatible." + +#: src/ggd-options.c:475 +#, c-format +msgid "Unknown value type for keyfile entry %s::%s" +msgstr "Type de valeur inconnue pour l'entrée de fichier de clé %s::%s" + +#: src/ggd-options.c:479 +#, c-format +msgid "Error retrieving keyfile entry %s::%s: %s" +msgstr "" +"Erreur lors de la récupération de l'entrée de fichier de clé %s::%s : %s" + +#: src/ggd-plugin.c:55 +msgid "Generates documentation comments basis from source code" +msgstr "" +"Génères des bases de commentaires de documentation depuis le code source" + +#: src/ggd-plugin.c:139 +#, c-format +msgid "Failed to load configuration: %s" +msgstr "Impossible de charger la configuration : %s" + +#: src/ggd-plugin.c:160 +#, c-format +msgid "Failed to save configuration: %s" +msgstr "Impossible d'enregistrer la configuration : %s" + +#: src/ggd-plugin.c:213 src/ggd-plugin.c:224 +msgid "Insert documentation comment" +msgstr "Insérer un commentaire de documentation" + +#: src/ggd-plugin.c:256 +#, c-format +msgid "Failed to find configuration file for file type "%s": %s" +msgstr "" +"Impossible de trouver le fichier de configuration pour le type de fichier « %" +"s » : %s" + +#. build "reload" item +#: src/ggd-plugin.c:286 +msgid "_Reload configuration files" +msgstr "_Recharger les fichiers de configuration" + +#. language filetypes opener +#: src/ggd-plugin.c:294 +msgid "_Edit current language configuration" +msgstr "Édit_er la configuration du langage courant" + +#. build tools menu item +#: src/ggd-plugin.c:299 +msgid "_Documentation generator" +msgstr "Générateur de _documentation" + +#: src/ggd-plugin.c:371 +msgid "Documentation _type:" +msgstr "_Type de documentation :" + +#. auto-save +#: src/ggd-plugin.c:378 +msgid "_Save file before generating comment" +msgstr "_Enregistrer le fichier avant de générer le commentaire" + +#: src/ggd-plugin.c:380 +msgid "" +"Whether to automatically save the file in which insert comment before " +"generating the comment. This is currently needed to have an up-to-date tag " +"list. If you disable this option and ask for comment generation on a " +"modified file, the behavior may be surprising (since the comment will be " +"generated for the last saved state)." +msgstr "" +"Choisis si il faut enregistrer automatiquement le fichier avant de générer " +"un commentaire. C'est actuellement nécessaire pour avoir une liste de tags à " +"jour. Si vous désactivez cette option et demandez la génération de " +"commentaire pour un fichier modifié, le résultat pourra être surprenant car " +"le commentaire sera généré pour le dernier état enregistré." + +#: src/ggd-utils.c:136 src/ggd-utils.c:147 +#, c-format +msgid "file "%s" exists but is not a regular file" +msgstr "le fichier « %s » existe mais n'est pas un fichier régulier" + +#: src/ggd-utils.c:156 +#, c-format +msgid "%s: no such file or directory" +msgstr "%s : aucun fichier ou répertoire de ce type"
Added: trunk/geanygendoc/src/Makefile.am =================================================================== --- trunk/geanygendoc/src/Makefile.am (rev 0) +++ trunk/geanygendoc/src/Makefile.am 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,36 @@ + +lib_LTLIBRARIES = geanygendoc.la +geanygendoc_la_SOURCES = ggd.c \ + ggd-doc-setting.c \ + ggd-doc-type.c \ + ggd-file-type.c \ + ggd-file-type-loader.c \ + ggd-file-type-manager.c \ + ggd-tag-utils.c \ + ggd-options.c \ + ggd-plugin.c \ + ggd-utils.c +noinst_HEADERS = ggd.h \ + ggd-doc-setting.h \ + ggd-doc-type.h \ + ggd-file-type.h \ + ggd-file-type-loader.h \ + ggd-file-type-manager.h \ + ggd-tag-utils.h \ + ggd-options.h \ + ggd-plugin.h \ + ggd-utils.h +geanygendoc_la_LDFLAGS = -module -avoid-version +geanygendoc_la_LIBADD = @GEANY_LIBS@ \ + @GLIB_LIBS@ \ + @GIO_LIBS@ \ + @GTK_LIBS@ \ + @CTPL_LIBS@ \ + $(INTLLIBS) + +AM_CFLAGS = @GEANY_CFLAGS@ \ + @GLIB_CFLAGS@ \ + @GIO_CFLAGS@ \ + @GTK_CFLAGS@ \ + @CTPL_CFLAGS@ \ + -DLOCALEDIR=""$(localedir)""
Added: trunk/geanygendoc/src/ggd-doc-setting.c =================================================================== --- trunk/geanygendoc/src/ggd-doc-setting.c (rev 0) +++ trunk/geanygendoc/src/ggd-doc-setting.c 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,195 @@ +/* + * + * Copyright © 2010 Colomban "Ban" Wendling ban@herbesfolles.org + * + * 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/. + * + */ + + +#include "ggd-doc-setting.h" + +#include <stdio.h> +#include <string.h> +#include <glib.h> +#include <ctpl/ctpl.h> +#include <geanyplugin.h> + + +GgdDocSetting * +ggd_doc_setting_new (const gchar *match) +{ + GgdDocSetting *setting; + + setting = g_slice_alloc (sizeof *setting); + setting->ref_count = 1; + setting->match = g_strdup (match); + setting->template = NULL; + setting->position = GGD_POS_BEFORE; + setting->policy = GGD_POLICY_KEEP; + setting->merge_children = FALSE; + setting->matches = tm_tag_max_t; + + /*g_debug ("New setting matching '%s'", match);*/ + + return setting; +} + +GgdDocSetting * +ggd_doc_setting_ref (GgdDocSetting *setting) +{ + g_return_val_if_fail (setting != NULL, NULL); + + g_atomic_int_inc (&setting->ref_count); + + return setting; +} + +void +ggd_doc_setting_unref (GgdDocSetting *setting) +{ + g_return_if_fail (setting != NULL); + + if (g_atomic_int_dec_and_test (&setting->ref_count)) { + g_free (setting->match); + ctpl_lexer_free_tree (setting->template); + g_slice_free1 (sizeof *setting, setting); + } +} + +void +ggd_doc_setting_dump (const GgdDocSetting *setting, + FILE *stream) +{ + g_return_if_fail (setting != NULL); + + fprintf (stream, " %s [%p]:\n" + " template: %p\n" + " position: %u\n" + " policy: %u\n", + setting->match, (gpointer)setting, + (gpointer)setting->template, + setting->position, + setting->policy); +} + +/** + * ggd_doc_setting_matches: + * @setting: A #GgdDocSetting + * @match: A match pattern + * @match_len: Length of @match or -1 if zero-terminated. + * + * Checks whether a #GgdDocSetting matches a given pattern. + * + * Returns: %TRUE if @setting matches the given pattern, %FALSE otherwise + */ +gboolean +ggd_doc_setting_matches (const GgdDocSetting *setting, + const gchar *match, + gssize match_len) +{ + gssize intern_i = strlen (setting->match); + gssize extern_i = match_len >= 0 ? match_len : (gssize)strlen (match); + gboolean matches = TRUE; + + g_return_val_if_fail (setting != NULL, FALSE); + + for (; intern_i >= 0 && extern_i >= 0 && matches; intern_i--, extern_i--) { + matches = setting->match[intern_i] == match[extern_i]; + } + + return matches && intern_i <= 0; +} + + + +/* Gets a position from a string. returns -1 on error */ +GgdPosition +ggd_position_from_string (const gchar *string) +{ + static const struct + { + const gchar *name; + GgdPosition pos; + } positions[] = { + { "BEFORE", GGD_POS_BEFORE }, + { "AFTER", GGD_POS_AFTER }, + { "CURSOR", GGD_POS_CURSOR } + }; + guint i; + + g_return_val_if_fail (string != NULL, -1); + + for (i = 0; i < G_N_ELEMENTS (positions); i++) { + if (strcmp (string, positions[i].name) == 0) { + /*g_debug ("matching position name: %s", positions[i].name);*/ + return positions[i].pos; + } + } + + return -1; +} + +/* Gets a policy from a string. returns -1 on error */ +GgdPolicy +ggd_policy_from_string (const gchar *string) +{ + static const struct + { + const gchar *name; + GgdPolicy policy; + } policies[] = { + { "KEEP", GGD_POLICY_KEEP }, + { "FORWARD", GGD_POLICY_FORWARD }/*, + { "DUPLICATE", GGD_POLICY_DUPLICATE }*/ + }; + guint i; + + g_return_val_if_fail (string != NULL, -1); + + for (i = 0; i < G_N_ELEMENTS (policies); i++) { + if (strcmp (string, policies[i].name) == 0) { + /*g_debug ("matching policy name: %s", policies[i].name);*/ + return policies[i].policy; + } + } + + return -1; +} + +/* Gets a merge policy from a string. returns -1 on error */ +gboolean +ggd_merge_policy_from_string (const gchar *string) +{ + static const struct + { + const gchar *name; + gboolean merge; + } policies[] = { + { "MERGE", TRUE }, + { "SPLIT", FALSE } + }; + guint i; + + g_return_val_if_fail (string != NULL, -1); + + for (i = 0; i < G_N_ELEMENTS (policies); i++) { + if (strcmp (string, policies[i].name) == 0) { + /*g_debug ("matching merge policy name: %s", policies[i].name);*/ + return policies[i].merge; + } + } + + return -1; +}
Added: trunk/geanygendoc/src/ggd-doc-setting.h =================================================================== --- trunk/geanygendoc/src/ggd-doc-setting.h (rev 0) +++ trunk/geanygendoc/src/ggd-doc-setting.h 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,78 @@ +/* + * + * Copyright © 2010 Colomban "Ban" Wendling ban@herbesfolles.org + * + * 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/. + * + */ + +#ifndef H_GGD_DOC_SETTING +#define H_GGD_DOC_SETTING + +#include <stdio.h> +#include <glib.h> +#include <ctpl/ctpl.h> + +#include "ggd-tag-utils.h" + +G_BEGIN_DECLS + + +typedef enum _GgdPosition +{ + GGD_POS_BEFORE, + GGD_POS_AFTER, + GGD_POS_CURSOR +} GgdPosition; + +typedef enum _GgdPolicy +{ + GGD_POLICY_KEEP, + GGD_POLICY_FORWARD/*, + GGD_POLICY_DUPLICATE*/ +} GgdPolicy; + +typedef struct _GgdDocSetting GgdDocSetting; + +struct _GgdDocSetting +{ + gint ref_count; + gchar *match; + + CtplToken *template; + GgdPosition position; + GgdPolicy policy; + gboolean merge_children; + TMTagType matches; +}; + + +GgdPosition ggd_position_from_string (const gchar *string); +GgdPolicy ggd_policy_from_string (const gchar *string); +gboolean ggd_merge_policy_from_string (const gchar *string); +#define ggd_match_from_string ggd_tag_type_from_name + +GgdDocSetting *ggd_doc_setting_new (const gchar *match); +GgdDocSetting *ggd_doc_setting_ref (GgdDocSetting *setting); +void ggd_doc_setting_unref (GgdDocSetting *setting); +void ggd_doc_setting_dump (const GgdDocSetting *setting, + FILE *stream); +gboolean ggd_doc_setting_matches (const GgdDocSetting *setting, + const gchar *match, + gssize match_len); + + +G_END_DECLS + +#endif /* guard */
Added: trunk/geanygendoc/src/ggd-doc-type.c =================================================================== --- trunk/geanygendoc/src/ggd-doc-type.c (rev 0) +++ trunk/geanygendoc/src/ggd-doc-type.c 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,202 @@ +/* + * + * Copyright © 2010 Colomban "Ban" Wendling ban@herbesfolles.org + * + * 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/. + * + */ + + +#include "ggd-doc-type.h" + +#include <stdio.h> +#include <string.h> +#include <glib.h> + +#include "ggd-doc-setting.h" + + +/** + * ggd_doc_type_new: + * @name: Documentation type's name + * + * Creates a new documentation type representation. + * + * Returns: The newly created #GgdDocType. Free with ggd_doc_type_free(). + */ +GgdDocType * +ggd_doc_type_new (const gchar *name) +{ + GgdDocType *doctype; + + g_return_val_if_fail (name != NULL, NULL); + + doctype = g_slice_alloc (sizeof *doctype); + doctype->ref_count = 1; + doctype->name = g_strdup (name); + doctype->settings = NULL; + + /*g_debug ("New doc type '%s' [%p]", name, doctype);*/ + + return doctype; +} + +/** + * ggd_doc_type_ref: + * @doctype: A #GgdDocType + * + * Adds a reference to @doctype + * + * Returns: the given @doctype + */ +GgdDocType * +ggd_doc_type_ref (GgdDocType *doctype) +{ + g_return_val_if_fail (doctype != NULL, NULL); + + g_atomic_int_inc (&doctype->ref_count); + + return doctype; +} + +/** + * ggd_doc_type_unref: + * @doctype: A #GgdDocType + * + * Removes a reference from @doctype and destroy it if it reaches 0. + */ +void +ggd_doc_type_unref (GgdDocType *doctype) +{ + g_return_if_fail (doctype != NULL); + + if (g_atomic_int_dec_and_test (&doctype->ref_count)) { + g_free (doctype->name); + while (doctype->settings) { + GList *tmp = doctype->settings; + + doctype->settings = g_list_next (doctype->settings); + ggd_doc_setting_unref (tmp->data); + g_list_free_1 (tmp); + } + g_slice_free1 (sizeof *doctype, doctype); + } +} + +/** + * ggd_doc_type_dump: + * @doctype: A #GgdDocType object + * @fp: File stream where write doctype dump. + * + * Dumps @doctype to @stream. + */ +void +ggd_doc_type_dump (const GgdDocType *doctype, + FILE *stream) +{ + g_return_if_fail (doctype != NULL); + + fprintf (stream, "DocType %s [%p]:\n", doctype->name, (gpointer)doctype); + g_list_foreach (doctype->settings, (GFunc)ggd_doc_setting_dump, stream); +} + +/** + * ggd_doc_type_get_setting: + * @doctype: A #GgdDocType + * @match: A match "pattern" + * + * Gets the setting that matches @match (the one that should be used for the + * given match). + * + * Returns: the first matching #GgdDocSetting or %NULL if none matches. + */ +GgdDocSetting * +ggd_doc_type_get_setting (const GgdDocType *doctype, + const gchar *match) +{ + GgdDocSetting *setting = NULL; + GList *tmp; + gssize match_len = strlen (match); + + g_return_val_if_fail (doctype != NULL, NULL); + + for (tmp = doctype->settings; tmp && ! setting; tmp = g_list_next (tmp)) { + if (ggd_doc_setting_matches (tmp->data, match, match_len)) { + setting = tmp->data; + } + } + + return setting; +} + +/* gets the match for the parent of the given one (e.g. foo.bar when given + * foo.bar.baz) */ +static gchar * +get_parent_match (const gchar *match) +{ + gchar *last_dot; + + last_dot = strrchr (match, '.'); + + return last_dot ? g_strndup (match, (gsize)(last_dot - match)) : NULL; +} + +/** + * ggd_doc_type_resolve_setting: + * @doctype: A #GgdDocType + * @match: A match "pattern" + * @nth_child: return location for the number of redirections to go to the final + * match + * + * Resolve the setting that should be applied fo match @match. This is similar + * to ggd_doc_type_get_setting() but applies the policy too (e.g. if @match + * matches a setting of which the policy is FORWARD, this function will try to + * resolve the parent and return it, and so on). + * + * Returns: the matching #GgdDocSetting or %NULL if none matches. + */ + /* FIXME: this doesn't support DUPLICATE, but it is quite useless... */ +GgdDocSetting * +ggd_doc_type_resolve_setting (const GgdDocType *doctype, + const gchar *match, + gint *nth_child) +{ + GgdDocSetting *setting = NULL; + gchar *child_match = g_strdup (match); + + g_return_val_if_fail (doctype != NULL, NULL); + + /*g_debug ("Resolving match "%s"...", child_match);*/ + if (nth_child) (*nth_child) = 0; + setting = ggd_doc_type_get_setting (doctype, child_match); + while (setting && setting->policy != GGD_POLICY_KEEP) { + gchar *parent_match = get_parent_match (child_match); + + if (nth_child) (*nth_child)++; + /*g_debug ("going to parent (%s)", parent_match);*/ + if (! parent_match) { + setting = NULL; + } else { + setting = ggd_doc_type_get_setting (doctype, parent_match); + g_free (child_match); + child_match = parent_match; + } + } + g_free (child_match); + /*g_debug ("Result is: %s (%p)", + setting ? setting->match : "(null)", + (gpointer)setting);*/ + + return setting; +}
Added: trunk/geanygendoc/src/ggd-doc-type.h =================================================================== --- trunk/geanygendoc/src/ggd-doc-type.h (rev 0) +++ trunk/geanygendoc/src/ggd-doc-type.h 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,55 @@ +/* + * + * Copyright © 2010 Colomban "Ban" Wendling ban@herbesfolles.org + * + * 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/. + * + */ + +#ifndef H_GGD_DOC_TYPE +#define H_GGD_DOC_TYPE + +#include <stdio.h> +#include <glib.h> + +#include "ggd-doc-setting.h" + +G_BEGIN_DECLS + + +typedef struct _GgdDocType GgdDocType; + +struct _GgdDocType +{ + gint ref_count; + gchar *name; + GList *settings; +}; + + +GgdDocType *ggd_doc_type_new (const gchar *name); +GgdDocType *ggd_doc_type_ref (GgdDocType *doctype); +void ggd_doc_type_unref (GgdDocType *doctype); +void ggd_doc_type_dump (const GgdDocType *doctype, + FILE *stream); +GgdDocSetting *ggd_doc_type_get_setting (const GgdDocType *doctype, + const gchar *match); +GgdDocSetting *ggd_doc_type_resolve_setting (const GgdDocType *doctype, + const gchar *match, + gint *nth_child); + + +G_END_DECLS + +#endif /* guard */
Added: trunk/geanygendoc/src/ggd-file-type-loader.c =================================================================== --- trunk/geanygendoc/src/ggd-file-type-loader.c (rev 0) +++ trunk/geanygendoc/src/ggd-file-type-loader.c 2010-04-18 02:13:07 UTC (rev 1252) @@ -0,0 +1,945 @@ +/* + * + * Copyright © 2010 Colomban "Ban" Wendling ban@herbesfolles.org + * + * 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/. + * + */ + +/* + * FIXME: This file is a little big and have some duplicated things. Try to + * merge and/or what can be. + */ + + +#include "ggd-file-type-loader.h" + +#include <glib.h> +#include <string.h> +#include <sys/types.h> +#include <sys/stat.h> +#include <fcntl.h> +#include <unistd.h> +#include <errno.h> +#include <ctpl/ctpl.h> +#include <geanyplugin.h> + +#include "ggd-doc-setting.h" +#include "ggd-doc-type.h" +#include "ggd-file-type.h" + + +/** + * ggd-file-type-loader: + * + * Loader for #GgdFileType, that provides ggd_file_type_load(). + * + * File type is of the form: + * + * <code> + * string ::= ( """ .* """ | "'" .* "'" ) + * constant ::= [_A-Z][_A-Z0-9]+ + * integer ::= [0-9]+ + * setting_value ::= ( string | constant | integer ) + * setting ::= "setting-name" "=" setting_value ";" + * setting_list ::= ( "{" setting* "}" | setting ) + * setting_section ::= "settings" "=" setting_list + * + * position ::= ( "BEFORE" | "AFTER" | "CURSOR" ) + * policy ::= ( "KEEP" | "FORWARD" ) + * children ::= ( "SPLIT" | "MERGE" ) + * type ::= ( "class" | "enum" | "enumval" | "field" | + * "function" | "interface" | "member" | "method" | + * "namespace" | "package" | "prototype" | "struct" | + * "typedef" | "union" | "variable" | "extern" | + * "define" | "macro" | "file" ) + * matches ::= type ( "|" type )* + * doctype_subsetting ::= ( "template" "=" string | + * "position" "=" position | + * "policy" "=" policy | + * "children" "=" children | + * "matches" "=" matches ) ";" + * match ::= type ( "." type )* + * doctype_setting ::= ( match "=" "{" doctype_subsetting* "}" | + * match "." doctype_subsetting ) + * doctype_setting_list ::= ( "{" doctype_setting* "}" | doctype_setting ) + * doctype ::= "doctype-name" "=" doctype_setting_list + * doctype_list ::= ( "{" doctype* "}" | doctype ) + * doctype_section ::= "doctypes" "=" doctype_list + * + * document ::= ( setting_section? doctype_section? | + * doctype_section? setting_section? ) + * </code> + */ + + +GQuark +ggd_file_type_load_error_quark (void) +{ + static GQuark q = 0; + + if (G_UNLIKELY (q == 0)) { + q = g_quark_from_static_string ("ggd-file-type-loader-error"); + } + + return q; +} + +/* reads #GgdDocSetting:template */ +static gboolean +ggd_file_type_read_setting_template (GScanner *scanner, + GgdDocSetting *setting) +{ + gboolean success = FALSE; + + if (g_scanner_get_next_token (scanner) != G_TOKEN_STRING) { + g_scanner_unexp_token (scanner, G_TOKEN_STRING, + NULL, NULL, NULL, NULL, TRUE); + } else { + GError *err = NULL; + CtplToken *tree; + + tree = ctpl_lexer_lex_string (scanner->value.v_string, &err); + if (! tree) { + g_scanner_error (scanner, _("invalid template: %s"), err->message); + g_error_free (err); + } else { + ctpl_lexer_free_tree (setting->template); + setting->template = tree; + success = TRUE; + } + } + + return success; +} + +/* reads #GgdDocSetting:position */ +static gboolean +ggd_file_type_read_setting_position (GScanner *scanner, + GgdDocSetting *setting) +{ + gboolean success = FALSE; + + if (g_scanner_get_next_token (scanner) != G_TOKEN_IDENTIFIER) { + g_scanner_unexp_token (scanner, G_TOKEN_IDENTIFIER, + _("position name"), NULL, NULL, NULL, TRUE); + } else { + const gchar *pos_string = scanner->value.v_identifier; + GgdPosition pos; + + pos = ggd_position_from_string (pos_string); + if ((gint)pos < 0) { + g_scanner_error (scanner, _("invalid position "%s""), pos_string); + } else { + setting->position = pos; + success = TRUE; + } + } + + return success; +} + +/* reads #GgdDocSetting:policy */ +static gboolean +ggd_file_type_read_setting_policy (GScanner *scanner, + GgdDocSetting *setting) +{ + gboolean success = FALSE; + + if (g_scanner_get_next_token (scanner) != G_TOKEN_IDENTIFIER) { + g_scanner_unexp_token (scanner, G_TOKEN_IDENTIFIER, + _("policy name"), NULL, NULL, NULL, TRUE); + } else { + const gchar *policy_string = scanner->value.v_identifier; + GgdPolicy policy; + + policy = ggd_policy_from_string (policy_string); + if ((gint)policy < 0) { + g_scanner_error (scanner, _("invalid policy "%s""), policy_string); + } else { + setting->policy = policy; + success = TRUE; + } + } + + return success; +} + +/* reads #GgdDocSetting:merge_children */ +static gboolean +ggd_file_type_read_setting_children (GScanner *scanner, + GgdDocSetting *setting) +{ + gboolean success = FALSE; + + if (g_scanner_get_next_token (scanner) != G_TOKEN_IDENTIFIER) { + g_scanner_unexp_token (scanner, G_TOKEN_IDENTIFIER, + _("merge policy"), NULL, NULL, NULL, TRUE); + } else { + const gchar *merge_string = scanner->value.v_identifier; + gboolean merge; + + merge = ggd_merge_policy_from_string (merge_string); + if ((gint)merge < 0) { + g_scanner_error (scanner, _("invalid merge policy "%s""), merge_string); + } else { + setting->merge_children = merge; + success = TRUE; + } + } + + return success; +} + +/* reads #GgdDocSetting:matches */ +static gboolean +ggd_file_type_read_setting_matches (GScanner *scanner, + GgdDocSetting *setting) +{ + gboolean success = FALSE; + TMTagType match = 0; + + do { + success = FALSE; + if (g_scanner_get_next_token (scanner) != G_TOKEN_IDENTIFIER) { + g_scanner_unexp_token (scanner, G_TOKEN_IDENTIFIER, + _("type"), NULL, NULL, NULL, TRUE); + } else { + TMTagType type; + const gchar *match_string = scanner->value.v_identifier; + + type = ggd_match_from_string (match_string); + if (! type) { + g_scanner_error (scanner, _("invalid type "%s""), match_string); + } else { + if (g_scanner_peek_next_token (scanner) == '|') { + g_scanner_get_next_token (scanner); /* eat it */ + } + match |= type; + success = TRUE; + } + } + } while (success && g_scanner_peek_next_token (scanner) == G_TOKEN_IDENTIFIER); + if (success) { + setting->matches = match; + } + + return success; +} + +/* dispatches read of value of doctype subsetting @name */ +static gboolean +ggd_file_type_read_setting_value (GScanner *scanner, + const gchar *name, + GgdDocSetting *setting) +{ + static const struct + { + const gchar *setting; + gboolean (*handler) (GScanner *scanner, + GgdDocSetting *setting); + } settings_table[] = { + { "template", ggd_file_type_read_setting_template }, + { "position", ggd_file_type_read_setting_position }, + { "policy", ggd_file_type_read_setting_policy }, + { "children", ggd_file_type_read_setting_children }, + { "matches", ggd_file_type_read_setting_matches } + }; + gboolean success = FALSE; + gboolean found = FALSE; + guint i; + + for (i = 0; ! found && i < G_N_ELEMENTS (settings_table); i++) { + if (strcmp (settings_table[i].setting, name) == 0) { + success = settings_table[i].handler (scanner, setting); + if (success) { + if (g_scanner_get_next_token (scanner) != ';') { + g_scanner_unexp_token (scanner, ';', + NULL, NULL, NULL, NULL, TRUE); + success = FALSE; + } + } + found = TRUE; + } + } + if (! found) { + g_scanner_error (scanner, _("invalid setting name "%s""), name); + success = FALSE; + } + + return success; +} + +static gboolean +ggd_file_type_read_setting (GScanner *scanner, + GgdDocSetting *setting) +{ + gboolean success = TRUE; + gboolean multiple = FALSE; + GTokenType ttype; + + do { + ttype = g_scanner_get_next_token (scanner); + switch (ttype) { + case G_TOKEN_LEFT_CURLY: + if (multiple) { + g_scanner_unexp_token (scanner, G_TOKEN_IDENTIFIER, + _("setting identifier"), NULL, NULL, NULL, + TRUE); + success = FALSE; + } else { + multiple = TRUE; + } + break; + + case G_TOKEN_RIGHT_CURLY: + if (! multiple) { + g_scanner_unexp_token (scanner, G_TOKEN_IDENTIFIER, + _("setting identifier"), NULL, NULL, NULL, + TRUE); + success = FALSE; + } + break; + + case G_TOKEN_IDENTIFIER: { + /* need to backup identifier as we call get_next_toekn() before using + * it */ + gchar *identifier = g_strdup (scanner->value.v_identifier); + + if (g_scanner_get_next_token (scanner) != G_TOKEN_EQUAL_SIGN) { + g_scanner_unexp_token (scanner, G_TOKEN_EQUAL_SIGN, + NULL, NULL, NULL, NULL, TRUE); + success = FALSE; + } else { + success = ggd_file_type_read_setting_value (scanner, identifier, + setting); + } + g_free (identifier); + break; + } + + default: + g_scanner_unexp_token (scanner, G_TOKEN_IDENTIFIER, + _("setting identifier"), NULL, NULL, NULL, TRUE); + success = FALSE; + } + } while (success && multiple && ttype != G_TOKEN_RIGHT_CURLY); + + return success; +} + +static gchar * +ggd_file_type_read_match (GScanner *scanner, + gchar **setting) +{ + GString *match_str; + gchar *match = NULL; + gboolean done = FALSE; + gboolean success = TRUE; + + match_str = g_string_new (NULL); + do { + switch (g_scanner_get_next_token (scanner)) { + case G_TOKEN_IDENTIFIER: { + gchar *identifier; + gboolean is_setting_name = FALSE; + + identifier = g_strdup (scanner->value.v_identifier); + /*g_debug ("identifier is %s", identifier);*/ + switch (g_scanner_get_next_token (scanner)) { + case '.': /* skip it */ break; + + case G_TOKEN_EQUAL_SIGN: + /* just stop here, we're done */ + done = TRUE; + is_setting_name = g_scanner_peek_next_token (scanner) != G_TOKEN_LEFT_CURLY; + break; + + default: + g_scanner_unexp_token (scanner, G_TOKEN_EQUAL_SIGN, + NULL, NULL, NULL, NULL, TRUE); + success = FALSE; + } + if (success) { + if (is_setting_name) { + *setting = g_strdup (identifier); + } else {
@@ Diff output truncated at 100000 characters. @@
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.