diff options
author | Steve Frécinaux <code@istique.net> | 2009-10-22 00:27:57 +0200 |
---|---|---|
committer | Steve Frécinaux <code@istique.net> | 2009-10-23 09:28:39 +0200 |
commit | a8952b9e7b8bfdc4e5ad32841708492cf0998347 (patch) | |
tree | fd4ba3bef26a0625d0493d3822a84c0a0f3a76fa | |
download | libpeas-a8952b9e7b8bfdc4e5ad32841708492cf0998347.tar.gz |
Import gedit's C plugin system as GPE.
The Gedit namespace has been replaced by a GPE namespace which means
"Gedit Plugins Engine" or "Gnome Plugins Engine" as you prefer.
Only the C loader has been imported so far, and there are still a few
gedit-isms within the source code.
-rw-r--r-- | .gitignore | 53 | ||||
-rw-r--r-- | AUTHORS | 12 | ||||
-rw-r--r-- | COPYING | 674 | ||||
-rw-r--r-- | ChangeLog | 0 | ||||
-rw-r--r-- | INSTALL | 302 | ||||
-rw-r--r-- | Makefile.am | 4 | ||||
-rw-r--r-- | NEWS | 0 | ||||
-rw-r--r-- | README | 0 | ||||
-rwxr-xr-x | autogen.sh | 22 | ||||
-rw-r--r-- | configure.ac | 135 | ||||
-rw-r--r-- | libgpe/Makefile.am | 37 | ||||
-rw-r--r-- | libgpe/gpe-dirs.c | 69 | ||||
-rw-r--r-- | libgpe/gpe-dirs.h | 40 | ||||
-rw-r--r-- | libgpe/gpe-engine.c | 873 | ||||
-rw-r--r-- | libgpe/gpe-engine.h | 103 | ||||
-rw-r--r-- | libgpe/gpe-object-module.c | 315 | ||||
-rw-r--r-- | libgpe/gpe-object-module.h | 80 | ||||
-rw-r--r-- | libgpe/gpe-plugin-info-priv.h | 59 | ||||
-rw-r--r-- | libgpe/gpe-plugin-info.c | 345 | ||||
-rw-r--r-- | libgpe/gpe-plugin-info.h | 55 | ||||
-rw-r--r-- | libgpe/gpe-plugin-loader.c | 132 | ||||
-rw-r--r-- | libgpe/gpe-plugin-loader.h | 90 | ||||
-rw-r--r-- | libgpe/gpe-plugin.c | 277 | ||||
-rw-r--r-- | libgpe/gpe-plugin.h | 147 | ||||
-rw-r--r-- | loaders/Makefile.am | 1 | ||||
-rw-r--r-- | loaders/c/Makefile.am | 16 | ||||
-rw-r--r-- | loaders/c/gpe-plugin-loader-c.c | 179 | ||||
-rw-r--r-- | loaders/c/gpe-plugin-loader-c.h | 59 | ||||
-rw-r--r-- | po/LINGUAS | 3 | ||||
-rw-r--r-- | po/POTFILES.in | 9 | ||||
-rw-r--r-- | po/POTFILES.skip | 2 |
31 files changed, 4093 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..04f6d49 --- /dev/null +++ b/.gitignore @@ -0,0 +1,53 @@ +*.bak +*.lo +*.la +*.o +*~ +.*.sw[nop] +.deps +.libs +Makefile +Makefile.in +/aclocal.m4 +/autom4te.cache +/config.cache +/config.guess +/config.h +/config.h.in +/config.log +/config.lt +/config.status +/config.status.lineno +/config.sub +/configure +/configure.lineno +/data/Makefile.in +/depcomp +/gnome-doc-utils.make +/gtk-doc.make +/install-sh +/intltool-extract +/intltool-extract.in +/intltool-merge +/intltool-merge.in +/intltool-update +/intltool-update.in +/libplugins/Makefile.in +/libtool +/ltmain.sh +/m4 +/missing +/mkinstalldirs +/omf.make +/po/*.gmo +/po/*.mo +/po/.intltool-merge-cache +/po/Makefile +/po/Makefile.in +/po/Makefile.in.in +/po/POTFILES +/po/stamp-it +/py-compile +/so_locations +/stamp-h1 +/xmldocs.make @@ -0,0 +1,12 @@ +Contributors to the gedit plugin system: + + Paolo Maggi <paolo@gnome.org> + Paolo Borelli <pborelli@katamail.com> + Steve Frécinaux <code@istique.net> + Jesse van den Kieboom <jesse@icecrew.nl> + Ignacio Casal Quinteiro <icq@gnome.org> + +Contributors to Epiphany's plugin system: + + Marco Pesenti Gritti + Christian Persch <chpe@gnome.org> @@ -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>. diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/ChangeLog @@ -0,0 +1,302 @@ +Installation Instructions +************************* + +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, +2006, 2007, 2008, 2009 Free Software Foundation, Inc. + + This file is free documentation; the Free Software Foundation gives +unlimited permission to copy, distribute and modify it. + +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. + + 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. + + 4. Type `make install' to install the programs and any data files and + documentation. + + 5. 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. + + 6. Often, you can also type `make uninstall' to remove the installed + files again. + +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 `..'. + + 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'. + + 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. + + 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'. + +Optional Features +================= + + 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. + +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. + diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..de1f6b9 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,4 @@ +## Process this file with automake to produce Makefile.in +ACLOCAL_AMFLAGS = -I m4 + +SUBDIRS = libgpe loaders diff --git a/autogen.sh b/autogen.sh new file mode 100755 index 0000000..a197643 --- /dev/null +++ b/autogen.sh @@ -0,0 +1,22 @@ +#!/bin/sh +# Run this to generate all the initial makefiles, etc. + +srcdir=`dirname $0` +test -z "$srcdir" && srcdir=. + +PKG_NAME="libgpe" + +(test -f $srcdir/configure.ac \ + && test -f $srcdir/README \ + && test -d $srcdir/libgpe) || { + echo -n "**Error**: Directory "\`$srcdir\'" does not look like the" + echo " top-level $PKG_NAME directory" + exit 1 +} + +which gnome-autogen.sh || { + echo "You need to install gnome-common from the GNOME CVS" + exit 1 +} + +ACLOCAL_FLAGS="$ACLOCAL_FLAGS -I m4" REQUIRED_AUTOMAKE_VERSION=1.8 USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..52fb1ff --- /dev/null +++ b/configure.ac @@ -0,0 +1,135 @@ +dnl Process this file with autoconf to produce a configure script. + +AC_PREREQ(2.59) + +m4_define(gpe_major_version, 2) +m4_define(gpe_minor_version, 28) +m4_define(gpe_micro_version, 0) +m4_define(gpe_interface_age, 0) + +m4_define(gpe_binary_age, [m4_eval(100 * gpe_minor_version + gpe_micro_version)]) +m4_define(gpe_version, [gpe_major_version.gpe_minor_version.gpe_micro_version]) + +# libtool version related macros +m4_define(gpe_lt_current, [m4_eval(100 * gpe_minor_version + gpe_micro_version - gpe_interface_age)]) +m4_define(gpe_lt_revision, [gpe_interface_age]) +m4_define(gpe_lt_age, [m4_eval(gpe_binary_age - gpe_interface_age)]) + + +AC_INIT(libgpe, gpe_version, http://bugzilla.gnome.org/enter_bug.cgi?product=gedit) +AC_CONFIG_SRCDIR(libgpe/gpe-plugin.c) +AC_CONFIG_MACRO_DIR([m4]) + +AC_DEFINE(GPE_MAJOR_VERSION, gpe_major_version, [Gedit Plugins Engine major version]) +AC_SUBST(GPE_MAJOR_VERSION, gpe_major_version) +AC_DEFINE(GPE_MINOR_VERSION, gpe_minor_version, [Gedit Plugins Engine minor version]) +AC_SUBST(GPE_MINOR_VERSION, gpe_minor_version) +AC_DEFINE(GPE_MICRO_VERSION, gpe_micro_version, [Gedit Plugins Engine micro version]) +AC_SUBST(GPE_MICRO_VERSION, gpe_micro_version) + +GPE_API_VERSION=2.20 +AC_SUBST(GPE_API_VERSION) + +AM_INIT_AUTOMAKE([1.8 dist-bzip2 no-dist-gzip -Wno-portability]) + +AM_MAINTAINER_MODE +m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])]) + +AC_CONFIG_HEADERS(config.h) +AC_DISABLE_STATIC + +IT_PROG_INTLTOOL([0.40.0]) + +PKG_PROG_PKG_CONFIG + +AC_PROG_LIBTOOL + +GNOME_DOC_INIT +GTK_DOC_CHECK([1.0]) + +AC_ISC_POSIX +AC_PROG_CC +AC_PROG_INSTALL +AC_PROG_MAKE_SET + +AC_SYS_LARGEFILE + +AC_CHECK_FUNCS(fsync) + +dnl make sure we keep ACLOCAL_FLAGS around for maintainer builds to work +AC_SUBST(ACLOCAL_AMFLAGS, "$ACLOCAL_FLAGS -I m4") + +dnl ================================================================ +dnl Gettext stuff. +dnl ================================================================ + +GETTEXT_PACKAGE=gpe +AC_SUBST(GETTEXT_PACKAGE) +AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE,"$GETTEXT_PACKAGE", [Gettext package]) + +AM_GLIB_GNU_GETTEXT + +dnl ================================================================ +dnl Start of pkg-config checks +dnl ================================================================ + +PKG_CHECK_MODULES(GPE, [ + glib-2.0 >= 2.18.0 + gthread-2.0 >= 2.16.0 + gio-2.0 >= 2.16.0 + gtk+-2.0 >= 2.16.0 +]) + +dnl ================================================================ +dnl Libtool +dnl ================================================================ + +LT_CURRENT=gpe_lt_current +LT_REVISION=gpe_lt_revision +LT_AGE=gpe_lt_age +AC_SUBST(LT_CURRENT) +AC_SUBST(LT_REVISION) +AC_SUBST(LT_AGE) + + +dnl ================================================================ +dnl Misc +dnl ================================================================ +AC_PATH_PROG(GLIB_GENMARSHAL, glib-genmarshal) +AC_PATH_PROG(GLIB_MKENUMS, glib-mkenums) + +GNOME_COMPILE_WARNINGS(yes) + +AC_ARG_ENABLE(deprecations, + [AS_HELP_STRING([--enable-deprecations], + [warn about deprecated usages [default=no]])],, + [enable_deprecations=no]) + +if test "x$enable_deprecations" = "xyes"; then + DISABLE_DEPRECATED_CFLAGS="-DG_DISABLE_DEPRECATED -DGDK_DISABLE_DEPRECATED -DGTK_DISABLE_DEPRECATED \ + -DGDK_PIXBUF_DISABLE_DEPRECATED -DGNOME_DISABLE_DEPRECATED" + AC_SUBST(DISABLE_DEPRECATED_CFLAGS) +fi + +PLUGIN_LIBTOOL_FLAGS="-module -avoid-version" +LOADER_LIBTOOL_FLAGS="-module -avoid-version" +AC_SUBST(PLUGIN_LIBTOOL_FLAGS) +AC_SUBST(LOADER_LIBTOOL_FLAGS) + +AC_CONFIG_FILES([ +Makefile +libgpe/Makefile +loaders/Makefile +loaders/c/Makefile +po/Makefile.in +]) + +AC_OUTPUT + +echo " + +Configuration: + + Source code location: ${srcdir} + Compiler: ${CC} +" diff --git a/libgpe/Makefile.am b/libgpe/Makefile.am new file mode 100644 index 0000000..3615fbc --- /dev/null +++ b/libgpe/Makefile.am @@ -0,0 +1,37 @@ +lib_LTLIBRARIES = libgpe-2.0.la + +INCLUDES = \ + -I$(top_srcdir) \ + -I$(srcdir) \ + $(GPE_CFLAGS) \ + $(WARN_CFLAGS) \ + $(DISABLE_DEPRECATED_CFLAGS) \ + -DDATADIR=\""$(datadir)"\" \ + -DLIBDIR=\""$(libdir)"\" + +libgpe_2_0_la_LDFLAGS = \ + -version-info $(LT_CURRENT):$(LT_REVISION):$(LT_AGE) \ + -export-dynamic -no-undefined -export-symbols-regex "^[^_].*" + +libgpe_2_0_la_LIBADD = $(GPE_LIBS) + +INST_H_FILES = \ + gpe-plugin.h \ + gpe-plugin-info.h + +NOINST_H_FILES = \ + gpe-dirs.h \ + gpe-object-module.h \ + gpe-plugin-info-priv.h \ + gpe-plugin-loader.h \ + gpe-engine.h + +libgpe_2_0_la_SOURCES = \ + gpe-dirs.c \ + gpe-object-module.c \ + gpe-plugin.c \ + gpe-plugin-info.c \ + gpe-plugin-loader.c \ + gpe-engine.c \ + $(INST_H_FILES) \ + $(NOINST_H_FILES) diff --git a/libgpe/gpe-dirs.c b/libgpe/gpe-dirs.c new file mode 100644 index 0000000..6884642 --- /dev/null +++ b/libgpe/gpe-dirs.c @@ -0,0 +1,69 @@ +/* + * gpe-dirs.c + * This file is part of libgpe + * + * Copyright (C) 2008 Ignacio Casal Quinteiro + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#include "gpe-dirs.h" + +gchar * +gpe_dirs_get_data_dir (void) +{ + return g_build_filename (DATADIR, "libgpe-2.0", NULL); +} + +gchar * +gpe_dirs_get_lib_dir (void) +{ + return g_build_filename (LIBDIR, "libgpe-2.0", NULL); +} + +gchar * +gpe_dirs_get_user_plugins_dir (void) +{ + return g_build_filename (g_get_user_config_dir (), "libgpe", "plugins", NULL); +} + +gchar * +gpe_dirs_get_plugins_dir (void) +{ + gchar *lib_dir; + gchar *plugin_dir; + + lib_dir = gpe_dirs_get_lib_dir (); + plugin_dir = g_build_filename (lib_dir, "plugins", NULL); + + g_free (lib_dir); + + return plugin_dir; +} + +gchar * +gpe_dirs_get_plugin_loaders_dir (void) +{ + gchar *lib_dir; + gchar *loader_dir; + + lib_dir = gpe_dirs_get_lib_dir (); + loader_dir = g_build_filename (lib_dir, "loaders", NULL); + + g_free (lib_dir); + + return loader_dir; +} diff --git a/libgpe/gpe-dirs.h b/libgpe/gpe-dirs.h new file mode 100644 index 0000000..8d9f853 --- /dev/null +++ b/libgpe/gpe-dirs.h @@ -0,0 +1,40 @@ +/* + * gpet-dirs.h + * This file is part of libgpe + * + * Copyright (C) 2008 Ignacio Casal Quinteiro + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + + +#ifndef __GEDIT_DIRS_H__ +#define __GEDIT_DIRS_H__ + +#include <glib.h> + +G_BEGIN_DECLS + +gchar *gpe_dirs_get_data_dir (void); +gchar *gpe_dirs_get_lib_dir (void); +gchar *gpe_dirs_get_user_plugins_dir (void); +gchar *gpe_dirs_get_plugins_dir (void); +gchar *gpe_dirs_get_plugin_loaders_dir (void); + + +G_END_DECLS + +#endif /* __GEDIT_DIRS_H__ */ diff --git a/libgpe/gpe-engine.c b/libgpe/gpe-engine.c new file mode 100644 index 0000000..8ddcd6e --- /dev/null +++ b/libgpe/gpe-engine.c @@ -0,0 +1,873 @@ +/* + * gpe-engine.c + * This file is part of libgpe + * + * Copyright (C) 2002-2005 Paolo Maggi + * Copyright (C) 2009 Steve Frécinaux + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifdef HAVE_CONFIG_H +#include <config.h> +#endif + +#include <string.h> + +#include <glib/gi18n.h> + +#include "gpe-engine.h" +#include "gpe-plugin-info-priv.h" +#include "gpe-plugin-loader.h" +#include "gpe-object-module.h" +#include "gpe-plugin.h" +#include "gpe-dirs.h" +/*#include <gedit/gedit-prefs-manager.h>*/ + +#define GPE_ENGINE_BASE_KEY "/apps/gedit-2/plugins" +#define GPE_ENGINE_KEY GPE_ENGINE_BASE_KEY "/active-plugins" + +#define PLUGIN_EXT ".gedit-plugin" +#define LOADER_EXT G_MODULE_SUFFIX + +typedef struct +{ + GPEPluginLoader *loader; + GPEObjectModule *module; +} LoaderInfo; + +/* Signals */ +enum +{ + ACTIVATE_PLUGIN, + DEACTIVATE_PLUGIN, + LAST_SIGNAL +}; + +static guint signals[LAST_SIGNAL]; + +G_DEFINE_TYPE(GPEEngine, gpe_engine, G_TYPE_OBJECT) + +struct _GPEEnginePrivate +{ + gchar **plugins_dirs; + + GList *plugin_list; + GHashTable *loaders; + + GList *object_list; + + gboolean activate_from_prefs; +}; + +static void gpe_engine_activate_plugin_real (GPEEngine *engine, + GPEPluginInfo *info); +static void gpe_engine_deactivate_plugin_real (GPEEngine *engine, + GPEPluginInfo *info); + +typedef gboolean (*LoadDirCallback) (GPEEngine *engine, const gchar *filename, gpointer userdata); + +static void +dummy (GPEEngine *engine, GPEPluginInfo *info) +{ + /* Empty */ +} + +static gboolean +load_dir_real (GPEEngine *engine, + const gchar *dir, + const gchar *suffix, + LoadDirCallback callback, + gpointer userdata) +{ + GError *error = NULL; + GDir *d; + const gchar *dirent; + gboolean ret = TRUE; + + g_return_val_if_fail (dir != NULL, TRUE); + + d = g_dir_open (dir, 0, &error); + if (!d) + { + g_warning ("%s", error->message); + g_error_free (error); + return TRUE; + } + + while ((dirent = g_dir_read_name (d))) + { + gchar *filename; + + if (!g_str_has_suffix (dirent, suffix)) + continue; + + filename = g_build_filename (dir, dirent, NULL); + + ret = callback (engine, filename, userdata); + + g_free (filename); + + if (!ret) + break; + } + + g_dir_close (d); + return ret; +} + +static gboolean +load_plugin_info (GPEEngine *engine, + const gchar *filename, + gpointer userdata) +{ + GPEPluginInfo *info; + + info = _gpe_plugin_info_new (filename); + + if (info == NULL) + return TRUE; + + /* If a plugin with this name has already been loaded + * drop this one (user plugins override system plugins) */ + if (gpe_engine_get_plugin_info (engine, gpe_plugin_info_get_module_name (info)) != NULL) + { + _gpe_plugin_info_unref (info); + + return TRUE; + } + + engine->priv->plugin_list = g_list_prepend (engine->priv->plugin_list, info); + + return TRUE; +} + +static void +load_all_plugins (GPEEngine *engine) +{ + gchar *plugin_dir; + const gchar *pdirs_env = NULL; + + /* load user plugins */ + plugin_dir = gpe_dirs_get_user_plugins_dir (); + if (g_file_test (plugin_dir, G_FILE_TEST_IS_DIR)) + { + load_dir_real (engine, + plugin_dir, + PLUGIN_EXT, + load_plugin_info, + NULL); + + } + g_free (plugin_dir); + + /* load system plugins */ + pdirs_env = g_getenv ("GPE_PLUGINS_PATH"); + + if (pdirs_env != NULL) + { + gchar **pdirs; + gint i; + + pdirs = g_strsplit (pdirs_env, G_SEARCHPATH_SEPARATOR_S, 0); + + for (i = 0; pdirs[i] != NULL; i++) + { + if (!load_dir_real (engine, + pdirs[i], + PLUGIN_EXT, + load_plugin_info, + NULL)) + { + break; + } + } + + g_strfreev (pdirs); + } + else + { + plugin_dir = gpe_dirs_get_plugins_dir (); + + load_dir_real (engine, + plugin_dir, + PLUGIN_EXT, + load_plugin_info, + NULL); + + g_free (plugin_dir); + } +} + +static guint +hash_lowercase (gconstpointer data) +{ + gchar *lowercase; + guint ret; + + lowercase = g_ascii_strdown ((const gchar *)data, -1); + ret = g_str_hash (lowercase); + g_free (lowercase); + + return ret; +} + +static gboolean +equal_lowercase (gconstpointer a, gconstpointer b) +{ + return g_ascii_strcasecmp ((const gchar *)a, (const gchar *)b) == 0; +} + +static void +loader_destroy (LoaderInfo *info) +{ + if (!info) + return; + + if (info->loader) + g_object_unref (info->loader); + + g_free (info); +} + +static void +add_loader (GPEEngine *engine, + const gchar *loader_id, + GPEObjectModule *module) +{ + LoaderInfo *info; + + info = g_new (LoaderInfo, 1); + info->loader = NULL; + info->module = module; + + g_hash_table_insert (engine->priv->loaders, g_strdup (loader_id), info); +} + +static void +gpe_engine_init (GPEEngine *engine) +{ + if (!g_module_supported ()) + { + g_warning ("libgpe is not able to initialize the plugins engine."); + return; + } + + engine->priv = G_TYPE_INSTANCE_GET_PRIVATE (engine, + GPE_TYPE_ENGINE, + GPEEnginePrivate); + + engine->priv->object_list = NULL; + + load_all_plugins (engine); + + /* make sure that the first reactivation will read active plugins + from the prefs */ + engine->priv->activate_from_prefs = TRUE; + + /* mapping from loadername -> loader object */ + engine->priv->loaders = g_hash_table_new_full (hash_lowercase, + equal_lowercase, + (GDestroyNotify)g_free, + (GDestroyNotify)loader_destroy); +} + +static void +loader_garbage_collect (const char *id, LoaderInfo *info) +{ + if (info->loader) + gpe_plugin_loader_garbage_collect (info->loader); +} + +void +gpe_engine_garbage_collect (GPEEngine *engine) +{ + g_hash_table_foreach (engine->priv->loaders, + (GHFunc) loader_garbage_collect, + NULL); +} + +static void +gpe_engine_finalize (GObject *object) +{ + GPEEngine *engine = GPE_ENGINE (object); + GList *item; + + /* First deactivate all plugins */ + for (item = engine->priv->plugin_list; item; item = item->next) + { + GPEPluginInfo *info = GPE_PLUGIN_INFO (item->data); + + if (gpe_plugin_info_is_active (info)) + gpe_engine_deactivate_plugin_real (engine, info); + } + + /* unref the loaders */ + g_hash_table_destroy (engine->priv->loaders); + + /* and finally free the infos */ + for (item = engine->priv->plugin_list; item; item = item->next) + { + GPEPluginInfo *info = GPE_PLUGIN_INFO (item->data); + + _gpe_plugin_info_unref (info); + } + + g_list_free (engine->priv->plugin_list); + g_list_free (engine->priv->object_list); + + G_OBJECT_CLASS (gpe_engine_parent_class)->finalize (object); +} + +static void +gpe_engine_class_init (GPEEngineClass *klass) +{ + GType the_type = G_TYPE_FROM_CLASS (klass); + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + object_class->finalize = gpe_engine_finalize; + klass->activate_plugin = gpe_engine_activate_plugin_real; + klass->deactivate_plugin = gpe_engine_deactivate_plugin_real; + klass->plugin_deactivated = dummy; + + signals[ACTIVATE_PLUGIN] = + g_signal_new ("activate-plugin", + the_type, + G_SIGNAL_RUN_LAST, + G_STRUCT_OFFSET (GPEEngineClass, activate_plugin), + NULL, NULL, + g_cclosure_marshal_VOID__BOXED, + G_TYPE_NONE, + 1, + GPE_TYPE_PLUGIN_INFO | G_SIGNAL_TYPE_STATIC_SCOPE); + + signals[DEACTIVATE_PLUGIN] = + g_signal_new ("deactivate-plugin", + the_type, + G_SIGNAL_RUN_LAST, + G_STRUCT_OFFSET (GPEEngineClass, deactivate_plugin), + NULL, NULL, + g_cclosure_marshal_VOID__BOXED, + G_TYPE_NONE, + 1, + GPE_TYPE_PLUGIN_INFO | G_SIGNAL_TYPE_STATIC_SCOPE); + + g_type_class_add_private (klass, sizeof (GPEEnginePrivate)); +} + +static gboolean +load_loader (GPEEngine *engine, + const gchar *filename, + gpointer data) +{ + GPEObjectModule *module; + gchar *base; + gchar *path; + const gchar *id; + GType type; + + /* try to load in the module */ + path = g_path_get_dirname (filename); + base = g_path_get_basename (filename); + + /* for now they are all resident */ + module = gpe_object_module_new (base, + path, + "register_gpe_plugin_loader", + TRUE); + + g_free (base); + g_free (path); + + /* make sure to load the type definition */ + if (!g_type_module_use (G_TYPE_MODULE (module))) + { + g_object_unref (module); + g_warning ("Plugin loader module `%s' could not be loaded", filename); + + return TRUE; + } + + /* get the exported type and check the name as exported by the + * loader interface */ + type = gpe_object_module_get_object_type (module); + id = gpe_plugin_loader_type_get_id (type); + + add_loader (engine, id, module); + g_type_module_unuse (G_TYPE_MODULE (module)); + + return TRUE; +} + +static void +ensure_loader (LoaderInfo *info) +{ + if (info->loader == NULL && info->module != NULL) + { + /* create a new loader object */ + GPEPluginLoader *loader; + loader = (GPEPluginLoader *)gpe_object_module_new_object (info->module, NULL); + + if (loader == NULL || !GPE_IS_PLUGIN_LOADER (loader)) + { + g_warning ("Loader object is not a valid GPEPluginLoader instance"); + + if (loader != NULL && G_IS_OBJECT (loader)) + g_object_unref (loader); + } + else + { + info->loader = loader; + } + } +} + +static GPEPluginLoader * +get_plugin_loader (GPEEngine *engine, + GPEPluginInfo *info) +{ + const gchar *loader_id; + LoaderInfo *loader_info; + + loader_id = info->loader; + + loader_info = (LoaderInfo *)g_hash_table_lookup ( + engine->priv->loaders, + loader_id); + + if (loader_info == NULL) + { + gchar *loader_dir; + + loader_dir = gpe_dirs_get_plugin_loaders_dir (); + + /* loader could not be found in the hash, try to find it by + scanning */ + load_dir_real (engine, + loader_dir, + LOADER_EXT, + (LoadDirCallback)load_loader, + NULL); + g_free (loader_dir); + + loader_info = (LoaderInfo *)g_hash_table_lookup ( + engine->priv->loaders, + loader_id); + } + + if (loader_info == NULL) + { + /* cache non-existent so we don't scan again */ + add_loader (engine, loader_id, NULL); + return NULL; + } + + ensure_loader (loader_info); + return loader_info->loader; +} + +const GList * +gpe_engine_get_plugin_list (GPEEngine *engine) +{ + return engine->priv->plugin_list; +} + +static gint +compare_plugin_info_and_name (GPEPluginInfo *info, + const gchar *module_name) +{ + return strcmp (gpe_plugin_info_get_module_name (info), module_name); +} + +GPEPluginInfo * +gpe_engine_get_plugin_info (GPEEngine *engine, + const gchar *name) +{ + GList *l = g_list_find_custom (engine->priv->plugin_list, + name, + (GCompareFunc) compare_plugin_info_and_name); + + return l == NULL ? NULL : (GPEPluginInfo *) l->data; +} + +static void +save_active_plugin_list (GPEEngine *engine) +{ + GSList *active_plugins = NULL; + GList *l; + + for (l = engine->priv->plugin_list; l != NULL; l = l->next) + { + GPEPluginInfo *info = (GPEPluginInfo *) l->data; + + if (gpe_plugin_info_is_active (info)) + { + active_plugins = g_slist_prepend (active_plugins, + (gpointer)gpe_plugin_info_get_module_name (info)); + } + } + +/* gedit_prefs_manager_set_active_plugins (active_plugins); */ + + g_slist_free (active_plugins); +} + +static gchar * +find_plugin_data_dir (const gchar *install_dir, + GPEPluginInfo *info) +{ + gchar *gpe_lib_dir; + gchar *data_dir; + + /* If it's a "user" plugin the data dir is $install_dir/$module_name. + * if instead it's a "system" plugin the data dir is under + * $data_dir, so the data is located it's under + * $prefix/share/libgpe-2.0/plugins/$module_name. + */ + gpe_lib_dir = gpe_dirs_get_lib_dir (); + + /* CHECK: is checking the prefix enough or should we be more + * careful about normalizing paths etc? */ + if (g_str_has_prefix (install_dir, gpe_lib_dir)) + { + gchar *gpe_data_dir = gpe_dirs_get_data_dir (); + + data_dir = g_build_filename (gpe_data_dir, + "plugins", + info->module_name, + NULL); + + g_free (gpe_data_dir); + } + else + { + data_dir = g_build_filename (install_dir, + info->module_name, + NULL); + } + + g_free (gpe_lib_dir); + + return data_dir; +} + +static gboolean +load_plugin (GPEEngine *engine, + GPEPluginInfo *info) +{ + GPEPluginLoader *loader; + gchar *path; + gchar *data_dir; + + if (gpe_plugin_info_is_active (info)) + return TRUE; + + if (!gpe_plugin_info_is_available (info)) + return FALSE; + + loader = get_plugin_loader (engine, info); + + if (loader == NULL) + { + g_warning ("Could not find loader `%s' for plugin `%s'", info->loader, info->name); + info->available = FALSE; + return FALSE; + } + + path = g_path_get_dirname (info->file); + g_return_val_if_fail (path != NULL, FALSE); + + data_dir = find_plugin_data_dir (path, info); + + info->plugin = gpe_plugin_loader_load (loader, info, path, data_dir); + + g_free (data_dir); + g_free (path); + + if (info->plugin == NULL) + { + g_warning ("Error loading plugin '%s'", info->name); + info->available = FALSE; + return FALSE; + } + + return TRUE; +} + +static void +gpe_engine_activate_plugin_real (GPEEngine *engine, + GPEPluginInfo *info) +{ + const GList *item; + + if (!load_plugin (engine, info)) + return; + + for (item = engine->priv->object_list; item != NULL; item = item->next) + gpe_plugin_activate (info->plugin, G_OBJECT (item->data)); +} + +gboolean +gpe_engine_activate_plugin (GPEEngine *engine, + GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, FALSE); + + if (!gpe_plugin_info_is_available (info)) + return FALSE; + + if (gpe_plugin_info_is_active (info)) + return TRUE; + + g_signal_emit (engine, signals[ACTIVATE_PLUGIN], 0, info); + + if (gpe_plugin_info_is_active (info)) + save_active_plugin_list (engine); + + return gpe_plugin_info_is_active (info); +} + +static void +gpe_engine_deactivate_plugin_real (GPEEngine *engine, + GPEPluginInfo *info) +{ + const GList *item; + GPEPluginLoader *loader; + + if (!gpe_plugin_info_is_active (info) || + !gpe_plugin_info_is_available (info)) + return; + + for (item = engine->priv->object_list; item != NULL; item = item->next) + gpe_plugin_deactivate (info->plugin, G_OBJECT (item->data)); + + /* let engine subclasses perform required cleanups. */ + GPE_ENGINE_GET_CLASS (engine)->plugin_deactivated (engine, info); + + /* first unref the plugin (the loader still has one) */ + g_object_unref (info->plugin); + + /* find the loader and tell it to gc and unload the plugin */ + loader = get_plugin_loader (engine, info); + + gpe_plugin_loader_garbage_collect (loader); + gpe_plugin_loader_unload (loader, info); + + info->plugin = NULL; +} + +gboolean +gpe_engine_deactivate_plugin (GPEEngine *engine, + GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, FALSE); + + if (!gpe_plugin_info_is_active (info)) + return TRUE; + + g_signal_emit (engine, signals[DEACTIVATE_PLUGIN], 0, info); + if (!gpe_plugin_info_is_active (info)) + save_active_plugin_list (engine); + + return !gpe_plugin_info_is_active (info); +} + +static void +gpe_engine_activate_plugins (GPEEngine *engine, + GObject *target_object) +{ + GSList *active_plugins = NULL; + GList *pl; + + g_return_if_fail (GPE_IS_ENGINE (engine)); + g_return_if_fail (G_IS_OBJECT (target_object)); + + /* the first time, we get the 'active' plugins from gconf */ + if (engine->priv->activate_from_prefs) + { +/* active_plugins = gedit_prefs_manager_get_active_plugins (); */ + } + + for (pl = engine->priv->plugin_list; pl; pl = pl->next) + { + GPEPluginInfo *info = (GPEPluginInfo*)pl->data; + + if (engine->priv->activate_from_prefs && + g_slist_find_custom (active_plugins, + gpe_plugin_info_get_module_name (info), + (GCompareFunc)strcmp) == NULL) + continue; + + /* If plugin is not active, don't try to activate/load it */ + if (!engine->priv->activate_from_prefs && + !gpe_plugin_info_is_active (info)) + continue; + + if (load_plugin (engine, info)) + gpe_plugin_activate (info->plugin, target_object); + } + + if (engine->priv->activate_from_prefs) + { + g_slist_foreach (active_plugins, (GFunc) g_free, NULL); + g_slist_free (active_plugins); + engine->priv->activate_from_prefs = FALSE; + } + + /* also call update_ui after activation */ + gpe_engine_update_plugins_ui (engine, target_object); +} + +static void +gpe_engine_deactivate_plugins (GPEEngine *engine, + GObject *target_object) +{ + GList *pl; + + g_return_if_fail (GPE_IS_ENGINE (engine)); + g_return_if_fail (G_IS_OBJECT (target_object)); + + for (pl = engine->priv->plugin_list; pl; pl = pl->next) + { + GPEPluginInfo *info = (GPEPluginInfo*)pl->data; + + /* check if the plugin is actually active */ + if (!gpe_plugin_info_is_active (info)) + continue; + + /* call deactivate for the plugin for this window */ + gpe_plugin_deactivate (info->plugin, target_object); + } +} + +void +gpe_engine_update_plugins_ui (GPEEngine *engine, + GObject *target_object) +{ + GList *pl; + + g_return_if_fail (GPE_IS_ENGINE (engine)); + g_return_if_fail (G_IS_OBJECT (target_object)); + + /* call update_ui for all active plugins */ + for (pl = engine->priv->plugin_list; pl; pl = pl->next) + { + GPEPluginInfo *info = (GPEPluginInfo*)pl->data; + + if (!gpe_plugin_info_is_active (info)) + continue; + + gpe_plugin_update_ui (info->plugin, target_object); + } +} + +void +gpe_engine_configure_plugin (GPEEngine *engine, + GPEPluginInfo *info, + GtkWindow *parent) +{ + GtkWidget *conf_dlg; + + GtkWindowGroup *wg; + + g_return_if_fail (info != NULL); + + conf_dlg = gpe_plugin_create_configure_dialog (info->plugin); + g_return_if_fail (conf_dlg != NULL); + gtk_window_set_transient_for (GTK_WINDOW (conf_dlg), + parent); + + wg = gtk_window_get_group (parent); + if (wg == NULL) + { + wg = gtk_window_group_new (); + gtk_window_group_add_window (wg, parent); + } + + gtk_window_group_add_window (wg, + GTK_WINDOW (conf_dlg)); + + gtk_window_set_modal (GTK_WINDOW (conf_dlg), TRUE); + gtk_widget_show (conf_dlg); +} + +void +gpe_engine_active_plugins_changed (GPEEngine *engine) +{ + gboolean to_activate; + GSList *active_plugins = NULL; + GList *pl; + +/* active_plugins = gedit_prefs_manager_get_active_plugins (); */ + + for (pl = engine->priv->plugin_list; pl; pl = pl->next) + { + GPEPluginInfo *info = (GPEPluginInfo*)pl->data; + + if (!gpe_plugin_info_is_available (info)) + continue; + + to_activate = (g_slist_find_custom (active_plugins, + gpe_plugin_info_get_module_name (info), + (GCompareFunc)strcmp) != NULL); + + if (!gpe_plugin_info_is_active (info) && to_activate) + g_signal_emit (engine, signals[ACTIVATE_PLUGIN], 0, info); + else if (gpe_plugin_info_is_active (info) && !to_activate) + g_signal_emit (engine, signals[DEACTIVATE_PLUGIN], 0, info); + } + + g_slist_foreach (active_plugins, (GFunc) g_free, NULL); + g_slist_free (active_plugins); +} + +void +gpe_engine_rescan_plugins (GPEEngine *engine) +{ + load_all_plugins (engine); +} + +void +gpe_engine_add_object (GPEEngine *engine, + GObject *object) +{ + g_return_if_fail (GPE_IS_ENGINE (engine)); + g_return_if_fail (G_IS_OBJECT (object)); + + /* Ensure we don't insert the same object twice... */ + if (g_list_find (engine->priv->object_list, object)) + return; + + /* Activate the plugin on object, and add it to the list of managed objects */ + gpe_engine_activate_plugins (engine, object); + engine->priv->object_list = g_list_prepend (engine->priv->object_list, object); +} + +void +gpe_engine_remove_object (GPEEngine *engine, + GObject *object) +{ + g_return_if_fail (GPE_IS_ENGINE (engine)); + g_return_if_fail (G_IS_OBJECT (object)); + + GList *item = g_list_find (engine->priv->object_list, object); + if (item == NULL) + return; + + /* Remove the object to the list of managed objects, and deactivate the plugin on it */ + engine->priv->object_list = g_list_delete_link (engine->priv->object_list, item); + gpe_engine_deactivate_plugins (engine, object); +} diff --git a/libgpe/gpe-engine.h b/libgpe/gpe-engine.h new file mode 100644 index 0000000..ab35872 --- /dev/null +++ b/libgpe/gpe-engine.h @@ -0,0 +1,103 @@ +/* + * gpe-engine.h + * This file is part of libgpe + * + * Copyright (C) 2002-2005 - Paolo Maggi + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef __GPE_ENGINE_H__ +#define __GPE_ENGINE_H__ + +#include <glib.h> +#include <gtk/gtk.h> +#include "gpe-plugin-info.h" +#include "gpe-plugin.h" + +G_BEGIN_DECLS + +#define GPE_TYPE_ENGINE (gpe_engine_get_type ()) +#define GPE_ENGINE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GPE_TYPE_ENGINE, GPEEngine)) +#define GPE_ENGINE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GPE_TYPE_ENGINE, GPEEngineClass)) +#define GPE_IS_ENGINE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GPE_TYPE_ENGINE)) +#define GPE_IS_ENGINE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GPE_TYPE_ENGINE)) +#define GPE_ENGINE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GPE_TYPE_ENGINE, GPEEngineClass)) + +typedef struct _GPEEngine GPEEngine; +typedef struct _GPEEnginePrivate GPEEnginePrivate; + +struct _GPEEngine +{ + GObject parent; + GPEEnginePrivate *priv; +}; + +typedef struct _GPEEngineClass GPEEngineClass; + +struct _GPEEngineClass +{ + GObjectClass parent_class; + + void (* activate_plugin) (GPEEngine *engine, + GPEPluginInfo *info); + + void (* deactivate_plugin) (GPEEngine *engine, + GPEPluginInfo *info); + + /* called when done deactivating the plugin, but before the plugin + * gets unloaded. */ + void (* plugin_deactivated) (GPEEngine *engine, + GPEPluginInfo *info); +}; + +GType gpe_engine_get_type (void) G_GNUC_CONST; + +void gpe_engine_garbage_collect (GPEEngine *engine); + +const GList *gpe_engine_get_plugin_list (GPEEngine *engine); + +GPEPluginInfo *gpe_engine_get_plugin_info (GPEEngine *engine, + const gchar *name); + +/* plugin load and unloading (overall, for all windows) */ +gboolean gpe_engine_activate_plugin (GPEEngine *engine, + GPEPluginInfo *info); +gboolean gpe_engine_deactivate_plugin (GPEEngine *engine, + GPEPluginInfo *info); + +void gpe_engine_configure_plugin (GPEEngine *engine, + GPEPluginInfo *info, + GtkWindow *parent); + +/* plugin activation/deactivation per target_object */ +void gpe_engine_update_plugins_ui (GPEEngine *engine, + GObject *target_object); + +/* private for gconf notification */ +void gpe_engine_active_plugins_changed (GPEEngine *engine); + +void gpe_engine_rescan_plugins (GPEEngine *engine); + +/* object management */ +void gpe_engine_add_object (GPEEngine *engine, + GObject *object); +void gpe_engine_remove_object (GPEEngine *engine, + GObject *object); + +G_END_DECLS + +#endif /* __GPE_ENGINE_H__ */ diff --git a/libgpe/gpe-object-module.c b/libgpe/gpe-object-module.c new file mode 100644 index 0000000..e27f0c9 --- /dev/null +++ b/libgpe/gpe-object-module.c @@ -0,0 +1,315 @@ +/* + * gpe-object-module.c + * This file is part of libgpe + * + * Copyright (C) 2003 Marco Pesenti Gritti + * Copyright (C) 2003-2004 Christian Persch + * Copyright (C) 2005-2007 Paolo Maggi + * Copyright (C) 2008 Jesse van den Kieboom + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#include "config.h" + +#include "gpe-object-module.h" + +typedef GType (*GPEObjectModuleRegisterFunc) (GTypeModule *); + +enum { + PROP_0, + PROP_MODULE_NAME, + PROP_PATH, + PROP_TYPE_REGISTRATION, + PROP_RESIDENT +}; + +struct _GPEObjectModulePrivate +{ + GModule *library; + + GType type; + gchar *path; + gchar *module_name; + gchar *type_registration; + + gboolean resident; +}; + +G_DEFINE_TYPE (GPEObjectModule, gpe_object_module, G_TYPE_TYPE_MODULE); + +static gboolean +gpe_object_module_load (GTypeModule *gmodule) +{ + GPEObjectModule *module = GPE_OBJECT_MODULE (gmodule); + GPEObjectModuleRegisterFunc register_func; + gchar *path; + + path = g_module_build_path (module->priv->path, module->priv->module_name); + g_return_val_if_fail (path != NULL, FALSE); + + module->priv->library = g_module_open (path, + G_MODULE_BIND_LAZY); + g_free (path); + + if (module->priv->library == NULL) + { + g_warning ("%s: %s", module->priv->module_name, g_module_error()); + + return FALSE; + } + + /* extract symbols from the lib */ + if (!g_module_symbol (module->priv->library, module->priv->type_registration, + (void *) ®ister_func)) + { + g_warning ("%s: %s", module->priv->module_name, g_module_error()); + g_module_close (module->priv->library); + + return FALSE; + } + + /* symbol can still be NULL even though g_module_symbol + * returned TRUE */ + if (register_func == NULL) + { + g_warning ("Symbol '%s' should not be NULL", module->priv->type_registration); + g_module_close (module->priv->library); + + return FALSE; + } + + module->priv->type = register_func (gmodule); + + if (module->priv->type == 0) + { + g_warning ("Invalid object contained by module %s", module->priv->module_name); + return FALSE; + } + + if (module->priv->resident) + { + g_module_make_resident (module->priv->library); + } + + return TRUE; +} + +static void +gpe_object_module_unload (GTypeModule *gmodule) +{ + GPEObjectModule *module = GPE_OBJECT_MODULE (gmodule); + + g_module_close (module->priv->library); + + module->priv->library = NULL; + module->priv->type = 0; +} + +static void +gpe_object_module_init (GPEObjectModule *module) +{ + module->priv = G_TYPE_INSTANCE_GET_PRIVATE (module, + GPE_TYPE_OBJECT_MODULE, + GPEObjectModulePrivate); +} + +static void +gpe_object_module_finalize (GObject *object) +{ + GPEObjectModule *module = GPE_OBJECT_MODULE (object); + + g_free (module->priv->path); + g_free (module->priv->module_name); + g_free (module->priv->type_registration); + + G_OBJECT_CLASS (gpe_object_module_parent_class)->finalize (object); +} + +static void +gpe_object_module_get_property (GObject *object, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + GPEObjectModule *module = GPE_OBJECT_MODULE (object); + + switch (prop_id) + { + case PROP_MODULE_NAME: + g_value_set_string (value, module->priv->module_name); + break; + case PROP_PATH: + g_value_set_string (value, module->priv->path); + break; + case PROP_TYPE_REGISTRATION: + g_value_set_string (value, module->priv->type_registration); + break; + case PROP_RESIDENT: + g_value_set_boolean (value, module->priv->resident); + break; + default: + g_return_if_reached (); + } +} + +static void +gpe_object_module_set_property (GObject *object, + guint prop_id, + const GValue *value, + GParamSpec *pspec) +{ + GPEObjectModule *module = GPE_OBJECT_MODULE (object); + + switch (prop_id) + { + case PROP_MODULE_NAME: + module->priv->module_name = g_value_dup_string (value); + g_type_module_set_name (G_TYPE_MODULE (object), + module->priv->module_name); + break; + case PROP_PATH: + module->priv->path = g_value_dup_string (value); + break; + case PROP_TYPE_REGISTRATION: + module->priv->type_registration = g_value_dup_string (value); + break; + case PROP_RESIDENT: + module->priv->resident = g_value_get_boolean (value); + break; + default: + g_return_if_reached (); + } +} + +static void +gpe_object_module_class_init (GPEObjectModuleClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (klass); + + object_class->set_property = gpe_object_module_set_property; + object_class->get_property = gpe_object_module_get_property; + object_class->finalize = gpe_object_module_finalize; + + module_class->load = gpe_object_module_load; + module_class->unload = gpe_object_module_unload; + + g_object_class_install_property (object_class, + PROP_MODULE_NAME, + g_param_spec_string ("module-name", + "Module Name", + "The module to load for this object", + NULL, + G_PARAM_READWRITE | + G_PARAM_CONSTRUCT_ONLY)); + + g_object_class_install_property (object_class, + PROP_PATH, + g_param_spec_string ("path", + "Path", + "The path to use when loading this module", + NULL, + G_PARAM_READWRITE | + G_PARAM_CONSTRUCT_ONLY)); + + g_object_class_install_property (object_class, + PROP_TYPE_REGISTRATION, + g_param_spec_string ("type-registration", + "Type Registration", + "The name of the type registration function", + NULL, + G_PARAM_READWRITE | + G_PARAM_CONSTRUCT_ONLY)); + + g_object_class_install_property (object_class, + PROP_RESIDENT, + g_param_spec_boolean ("resident", + "Resident", + "Whether the module is resident", + FALSE, + G_PARAM_READWRITE | + G_PARAM_CONSTRUCT_ONLY)); + + g_type_class_add_private (klass, sizeof (GPEObjectModulePrivate)); +} + +GPEObjectModule * +gpe_object_module_new (const gchar *module_name, + const gchar *path, + const gchar *type_registration, + gboolean resident) +{ + return (GPEObjectModule *)g_object_new (GPE_TYPE_OBJECT_MODULE, + "module-name", + module_name, + "path", + path, + "type-registration", + type_registration, + "resident", + resident, + NULL); +} + +GObject * +gpe_object_module_new_object (GPEObjectModule *module, + const gchar *first_property_name, + ...) +{ + va_list var_args; + GObject *result; + + g_return_val_if_fail (module->priv->type != 0, NULL); + + va_start (var_args, first_property_name); + result = g_object_new_valist (module->priv->type, first_property_name, var_args); + va_end (var_args); + + return result; +} + +const gchar * +gpe_object_module_get_path (GPEObjectModule *module) +{ + g_return_val_if_fail (GPE_IS_OBJECT_MODULE (module), NULL); + + return module->priv->path; +} + +const gchar * +gpe_object_module_get_module_name (GPEObjectModule *module) +{ + g_return_val_if_fail (GPE_IS_OBJECT_MODULE (module), NULL); + + return module->priv->module_name; +} + +const gchar * +gpe_object_module_get_type_registration (GPEObjectModule *module) +{ + g_return_val_if_fail (GPE_IS_OBJECT_MODULE (module), NULL); + + return module->priv->type_registration; +} + +GType +gpe_object_module_get_object_type (GPEObjectModule *module) +{ + g_return_val_if_fail (GPE_IS_OBJECT_MODULE (module), 0); + + return module->priv->type; +} diff --git a/libgpe/gpe-object-module.h b/libgpe/gpe-object-module.h new file mode 100644 index 0000000..fdd6510 --- /dev/null +++ b/libgpe/gpe-object-module.h @@ -0,0 +1,80 @@ +/* + * gpe-object-module.h + * This file is part of libgpe + * + * Copyright (C) 2003 Marco Pesenti Gritti + * Copyright (C) 2003, 2004 Christian Persch + * Copyright (C) 2005-2007 Paolo Maggi + * Copyright (C) 2008 Jesse van den Kieboom + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef __GPE_OBJECT_MODULE_H__ +#define __GPE_OBJECT_MODULE_H__ + +#include <glib-object.h> +#include <gmodule.h> +#include <stdarg.h> + +G_BEGIN_DECLS + +#define GPE_TYPE_OBJECT_MODULE (gpe_object_module_get_type ()) +#define GPE_OBJECT_MODULE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GPE_TYPE_OBJECT_MODULE, GPEObjectModule)) +#define GPE_OBJECT_MODULE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GPE_TYPE_OBJECT_MODULE, GPEObjectModuleClass)) +#define GPE_IS_OBJECT_MODULE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GPE_TYPE_OBJECT_MODULE)) +#define GPE_IS_OBJECT_MODULE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GPE_TYPE_OBJECT_MODULE)) +#define GPE_OBJECT_MODULE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GPE_TYPE_OBJECT_MODULE, GPEObjectModuleClass)) + +typedef struct _GPEObjectModule GPEObjectModule; +typedef struct _GPEObjectModulePrivate GPEObjectModulePrivate; + +struct _GPEObjectModule +{ + GTypeModule parent; + + GPEObjectModulePrivate *priv; +}; + +typedef struct _GPEObjectModuleClass GPEObjectModuleClass; + +struct _GPEObjectModuleClass +{ + GTypeModuleClass parent_class; + + /* Virtual class methods */ + void (* garbage_collect) (); +}; + +GType gpe_object_module_get_type (void) G_GNUC_CONST; + +GPEObjectModule *gpe_object_module_new (const gchar *module_name, + const gchar *path, + const gchar *type_registration, + gboolean resident); + +GObject *gpe_object_module_new_object (GPEObjectModule *module, + const gchar *first_property_name, + ...); + +GType gpe_object_module_get_object_type (GPEObjectModule *module); +const gchar *gpe_object_module_get_path (GPEObjectModule *module); +const gchar *gpe_object_module_get_module_name (GPEObjectModule *module); +const gchar *gpe_object_module_get_type_registration (GPEObjectModule *module); + +G_END_DECLS + +#endif diff --git a/libgpe/gpe-plugin-info-priv.h b/libgpe/gpe-plugin-info-priv.h new file mode 100644 index 0000000..5c808fd --- /dev/null +++ b/libgpe/gpe-plugin-info-priv.h @@ -0,0 +1,59 @@ +/* + * gpe-plugin-info-priv.h + * This file is part of libgpe + * + * Copyright (C) 2002-2005 - Paolo Maggi + * Copyright (C) 2007 - Steve Frécinaux + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef __GPE_PLUGIN_INFO_PRIV_H__ +#define __GPE_PLUGIN_INFO_PRIV_H__ + +#include "gpe-plugin-info.h" +#include "gpe-plugin.h" + +struct _GPEPluginInfo +{ + gint refcount; + + GPEPlugin *plugin; + gchar *file; + + gchar *module_name; + gchar *loader; + gchar **dependencies; + + gchar *name; + gchar *desc; + gchar *icon_name; + gchar **authors; + gchar *copyright; + gchar *website; + gchar *version; + + /* A plugin is unavailable if it is not possible to activate it + due to an error loading the plugin module (e.g. for Python plugins + when the interpreter has not been correctly initializated) */ + gint available : 1; +}; + +GPEPluginInfo *_gpe_plugin_info_new (const gchar *file); +void _gpe_plugin_info_ref (GPEPluginInfo *info); +void _gpe_plugin_info_unref (GPEPluginInfo *info); + +#endif /* __GPE_PLUGIN_INFO_PRIV_H__ */ diff --git a/libgpe/gpe-plugin-info.c b/libgpe/gpe-plugin-info.c new file mode 100644 index 0000000..39555c3 --- /dev/null +++ b/libgpe/gpe-plugin-info.c @@ -0,0 +1,345 @@ +/* + * gpe-plugin-info.c + * This file is part of libgpe + * + * Copyright (C) 2002-2005 - Paolo Maggi + * Copyright (C) 2007 - Steve Frécinaux + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifdef HAVE_CONFIG_H +#include <config.h> +#endif + +#include <string.h> +#include <glib/gi18n.h> +#include <glib.h> + +#include "gpe-plugin-info-priv.h" +#include "gpe-plugin.h" + +void +_gpe_plugin_info_ref (GPEPluginInfo *info) +{ + g_atomic_int_inc (&info->refcount); +} + +static GPEPluginInfo * +gpe_plugin_info_copy (GPEPluginInfo *info) +{ + _gpe_plugin_info_ref (info); + return info; +} + +void +_gpe_plugin_info_unref (GPEPluginInfo *info) +{ + if (!g_atomic_int_dec_and_test (&info->refcount)) + return; + + if (info->plugin != NULL) + g_object_unref (info->plugin); + + g_free (info->file); + g_free (info->module_name); + g_strfreev (info->dependencies); + g_free (info->name); + g_free (info->desc); + g_free (info->icon_name); + g_free (info->website); + g_free (info->copyright); + g_free (info->loader); + g_free (info->version); + g_strfreev (info->authors); + + g_free (info); +} + +/** + * gpe_plugin_info_get_type: + * + * Retrieves the #GType object which is associated with the #GPEPluginInfo + * class. + * + * Return value: the GType associated with #GPEPluginInfo. + **/ +GType +gpe_plugin_info_get_type (void) +{ + static GType the_type = 0; + + if (G_UNLIKELY (!the_type)) + the_type = g_boxed_type_register_static ( + "GPEPluginInfo", + (GBoxedCopyFunc) gpe_plugin_info_copy, + (GBoxedFreeFunc) _gpe_plugin_info_unref); + + return the_type; +} + +/** + * gpe_plugin_info_new: + * @filename: the filename where to read the plugin information + * + * Creates a new #GPEPluginInfo from a file on the disk. + * + * Return value: a newly created #GPEPluginInfo. + */ +GPEPluginInfo * +_gpe_plugin_info_new (const gchar *file) +{ + GPEPluginInfo *info; + GKeyFile *plugin_file = NULL; + gchar *str; + + g_return_val_if_fail (file != NULL, NULL); + + info = g_new0 (GPEPluginInfo, 1); + info->refcount = 1; + info->file = g_strdup (file); + + plugin_file = g_key_file_new (); + if (!g_key_file_load_from_file (plugin_file, file, G_KEY_FILE_NONE, NULL)) + { + g_warning ("Bad plugin file: %s", file); + goto error; + } + + if (!g_key_file_has_key (plugin_file, "Gedit Plugin", "IAge", NULL)) + goto error; + + /* Check IAge=2 */ + if (g_key_file_get_integer (plugin_file, "Gedit Plugin", "IAge", NULL) != 2) + goto error; + + /* Get module name */ + str = g_key_file_get_string (plugin_file, + "Gedit Plugin", + "Module", + NULL); + + if ((str != NULL) && (*str != '\0')) + { + info->module_name = str; + } + else + { + g_warning ("Could not find 'Module' in %s", file); + goto error; + } + + /* Get the dependency list */ + info->dependencies = g_key_file_get_string_list (plugin_file, + "Gedit Plugin", + "Depends", + NULL, + NULL); + if (info->dependencies == NULL) + info->dependencies = g_new0 (gchar *, 1); + + /* Get the loader for this plugin */ + str = g_key_file_get_string (plugin_file, + "Gedit Plugin", + "Loader", + NULL); + + if ((str != NULL) && (*str != '\0')) + { + info->loader = str; + } + else + { + /* default to the C loader */ + info->loader = g_strdup("c"); + } + + /* Get Name */ + str = g_key_file_get_locale_string (plugin_file, + "Gedit Plugin", + "Name", + NULL, NULL); + if (str) + info->name = str; + else + { + g_warning ("Could not find 'Name' in %s", file); + goto error; + } + + /* Get Description */ + str = g_key_file_get_locale_string (plugin_file, + "Gedit Plugin", + "Description", + NULL, NULL); + if (str) + info->desc = str; + + /* Get Icon */ + str = g_key_file_get_locale_string (plugin_file, + "Gedit Plugin", + "Icon", + NULL, NULL); + if (str) + info->icon_name = str; + + /* Get Authors */ + info->authors = g_key_file_get_string_list (plugin_file, + "Gedit Plugin", + "Authors", + NULL, + NULL); + + /* Get Copyright */ + str = g_key_file_get_string (plugin_file, + "Gedit Plugin", + "Copyright", + NULL); + if (str) + info->copyright = str; + + /* Get Website */ + str = g_key_file_get_string (plugin_file, + "Gedit Plugin", + "Website", + NULL); + if (str) + info->website = str; + + /* Get Version */ + str = g_key_file_get_string (plugin_file, + "Gedit Plugin", + "Version", + NULL); + if (str) + info->version = str; + + g_key_file_free (plugin_file); + + /* If we know nothing about the availability of the plugin, + set it as available */ + info->available = TRUE; + + return info; + +error: + g_free (info->file); + g_free (info->module_name); + g_free (info->name); + g_free (info->loader); + g_free (info); + g_key_file_free (plugin_file); + + return NULL; +} + +gboolean +gpe_plugin_info_is_active (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, FALSE); + + return info->available && info->plugin != NULL; +} + +gboolean +gpe_plugin_info_is_available (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, FALSE); + + return info->available != FALSE; +} + +gboolean +gpe_plugin_info_is_configurable (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, FALSE); + + if (info->plugin == NULL || !info->available) + return FALSE; + + return gpe_plugin_is_configurable (info->plugin); +} + +const gchar * +gpe_plugin_info_get_module_name (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, NULL); + + return info->module_name; +} + +const gchar * +gpe_plugin_info_get_name (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, NULL); + + return info->name; +} + +const gchar * +gpe_plugin_info_get_description (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, NULL); + + return info->desc; +} + +const gchar * +gpe_plugin_info_get_icon_name (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, NULL); + + /* use the gedit-plugin icon as a default if the plugin does not + have its own */ + if (info->icon_name != NULL && + gtk_icon_theme_has_icon (gtk_icon_theme_get_default (), + info->icon_name)) + return info->icon_name; + else + return "gedit-plugin"; +} + +const gchar ** +gpe_plugin_info_get_authors (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, (const gchar **)NULL); + + return (const gchar **) info->authors; +} + +const gchar * +gpe_plugin_info_get_website (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, NULL); + + return info->website; +} + +const gchar * +gpe_plugin_info_get_copyright (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, NULL); + + return info->copyright; +} + +const gchar * +gpe_plugin_info_get_version (GPEPluginInfo *info) +{ + g_return_val_if_fail (info != NULL, NULL); + + return info->version; +} diff --git a/libgpe/gpe-plugin-info.h b/libgpe/gpe-plugin-info.h new file mode 100644 index 0000000..4f837d7 --- /dev/null +++ b/libgpe/gpe-plugin-info.h @@ -0,0 +1,55 @@ +/* + * gpe-plugins-info.h + * This file is part of libgpe + * + * Copyright (C) 2002-2005 - Paolo Maggi + * Copyright (C) 2007 - Steve Frécinaux + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef __GPE_PLUGIN_INFO_H__ +#define __GPE_PLUGIN_INFO_H__ + +#include <glib-object.h> + +G_BEGIN_DECLS + +#define GPE_TYPE_PLUGIN_INFO (gpe_plugin_info_get_type ()) +#define GPE_PLUGIN_INFO(obj) ((GPEPluginInfo *) (obj)) + +typedef struct _GPEPluginInfo GPEPluginInfo; + +GType gpe_plugin_info_get_type (void) G_GNUC_CONST; + +gboolean gpe_plugin_info_is_active (GPEPluginInfo *info); +gboolean gpe_plugin_info_is_available (GPEPluginInfo *info); +gboolean gpe_plugin_info_is_configurable (GPEPluginInfo *info); + +const gchar *gpe_plugin_info_get_module_name (GPEPluginInfo *info); + +const gchar *gpe_plugin_info_get_name (GPEPluginInfo *info); +const gchar *gpe_plugin_info_get_description (GPEPluginInfo *info); +const gchar *gpe_plugin_info_get_icon_name (GPEPluginInfo *info); +const gchar **gpe_plugin_info_get_authors (GPEPluginInfo *info); +const gchar *gpe_plugin_info_get_website (GPEPluginInfo *info); +const gchar *gpe_plugin_info_get_copyright (GPEPluginInfo *info); +const gchar *gpe_plugin_info_get_version (GPEPluginInfo *info); + +G_END_DECLS + +#endif /* __GPE_PLUGIN_INFO_H__ */ + diff --git a/libgpe/gpe-plugin-loader.c b/libgpe/gpe-plugin-loader.c new file mode 100644 index 0000000..a4d44cd --- /dev/null +++ b/libgpe/gpe-plugin-loader.c @@ -0,0 +1,132 @@ +/* + * gpe-plugin-loader.c + * This file is part of libgpe + * + * Copyright (C) 2008 - Jesse van den Kieboom + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#include "gpe-plugin-loader.h" + +static void +gpe_plugin_loader_base_init (gpointer g_class) +{ + static gboolean initialized = FALSE; + + if (G_UNLIKELY (!initialized)) + { + /* create interface signals here. */ + initialized = TRUE; + } +} + +GType +gpe_plugin_loader_get_type (void) +{ + static GType type = 0; + + if (G_UNLIKELY (type == 0)) + { + static const GTypeInfo info = + { + sizeof (GPEPluginLoaderInterface), + gpe_plugin_loader_base_init, /* base_init */ + NULL, /* base_finalize */ + NULL, /* class_init */ + NULL, /* class_finalize */ + NULL, /* class_data */ + 0, + 0, /* n_preallocs */ + NULL /* instance_init */ + }; + + type = g_type_register_static (G_TYPE_INTERFACE, "GPEPluginLoader", &info, 0); + } + + return type; +} + +const gchar * +gpe_plugin_loader_type_get_id (GType type) +{ + GTypeClass *klass; + GPEPluginLoaderInterface *iface; + + klass = g_type_class_ref (type); + + if (klass == NULL) + { + g_warning ("Could not get class info for plugin loader"); + return NULL; + } + + iface = g_type_interface_peek (klass, GPE_TYPE_PLUGIN_LOADER); + + if (iface == NULL) + { + g_warning ("Could not get plugin loader interface"); + g_type_class_unref (klass); + + return NULL; + } + + g_return_val_if_fail (iface->get_id != NULL, NULL); + return iface->get_id (); +} + +GPEPlugin * +gpe_plugin_loader_load (GPEPluginLoader *loader, + GPEPluginInfo *info, + const gchar *path, + const gchar *datadir) +{ + GPEPluginLoaderInterface *iface; + + g_return_val_if_fail (GPE_IS_PLUGIN_LOADER (loader), NULL); + + iface = GPE_PLUGIN_LOADER_GET_INTERFACE (loader); + g_return_val_if_fail (iface->load != NULL, NULL); + + return iface->load (loader, info, path, datadir); +} + +void +gpe_plugin_loader_unload (GPEPluginLoader *loader, + GPEPluginInfo *info) +{ + GPEPluginLoaderInterface *iface; + + g_return_if_fail (GPE_IS_PLUGIN_LOADER (loader)); + + iface = GPE_PLUGIN_LOADER_GET_INTERFACE (loader); + g_return_if_fail (iface->unload != NULL); + + iface->unload (loader, info); +} + +void +gpe_plugin_loader_garbage_collect (GPEPluginLoader *loader) +{ + GPEPluginLoaderInterface *iface; + + g_return_if_fail (GPE_IS_PLUGIN_LOADER (loader)); + + iface = GPE_PLUGIN_LOADER_GET_INTERFACE (loader); + + if (iface->garbage_collect != NULL) + iface->garbage_collect (loader); +} diff --git a/libgpe/gpe-plugin-loader.h b/libgpe/gpe-plugin-loader.h new file mode 100644 index 0000000..239131c --- /dev/null +++ b/libgpe/gpe-plugin-loader.h @@ -0,0 +1,90 @@ +/* + * gpe-plugin-loader.h + * This file is part of libgpe + * + * Copyright (C) 2008 - Jesse van den Kieboom + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef __GPE_PLUGIN_LOADER_H__ +#define __GPE_PLUGIN_LOADER_H__ + +#include <glib-object.h> +#include "gpe-plugin.h" +#include "gpe-plugin-info.h" + +G_BEGIN_DECLS + +#define GPE_TYPE_PLUGIN_LOADER (gpe_plugin_loader_get_type ()) +#define GPE_PLUGIN_LOADER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GPE_TYPE_PLUGIN_LOADER, GPEPluginLoader)) +#define GPE_IS_PLUGIN_LOADER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GPE_TYPE_PLUGIN_LOADER)) +#define GPE_PLUGIN_LOADER_GET_INTERFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GPE_TYPE_PLUGIN_LOADER, GPEPluginLoaderInterface)) + +typedef struct _GPEPluginLoader GPEPluginLoader; /* dummy object */ +typedef struct _GPEPluginLoaderInterface GPEPluginLoaderInterface; + +struct _GPEPluginLoaderInterface { + GTypeInterface parent; + + const gchar *(*get_id) (void); + + GPEPlugin *(*load) (GPEPluginLoader *loader, + GPEPluginInfo *info, + const gchar *path, + const gchar *datadir); + + void (*unload) (GPEPluginLoader *loader, + GPEPluginInfo *info); + + void (*garbage_collect) (GPEPluginLoader *loader); +}; + +GType gpe_plugin_loader_get_type (void); + +const gchar *gpe_plugin_loader_type_get_id (GType type); +GPEPlugin *gpe_plugin_loader_load (GPEPluginLoader *loader, + GPEPluginInfo *info, + const gchar *path, + const gchar *datadir); +void gpe_plugin_loader_unload (GPEPluginLoader *loader, + GPEPluginInfo *info); +void gpe_plugin_loader_garbage_collect (GPEPluginLoader *loader); + +/** + * GPE_PLUGIN_LOADER_REGISTER_TYPE(PluginLoaderName, plugin_loader_name, PARENT_TYPE, loader_interface_init): + * + * Utility macro used to register plugin loaders. + */ +#define GPE_PLUGIN_LOADER_REGISTER_TYPE(PluginLoaderName, plugin_loader_name, PARENT_TYPE, loader_iface_init) \ + G_DEFINE_DYNAMIC_TYPE_EXTENDED (PluginLoaderName, \ + plugin_loader_name, \ + PARENT_TYPE, \ + 0, \ + G_IMPLEMENT_INTERFACE(GPE_TYPE_PLUGIN_LOADER, loader_iface_init)); \ + \ + \ +G_MODULE_EXPORT GType \ +register_gpe_plugin_loader (GTypeModule *type_module) \ +{ \ + plugin_loader_name##_register_type (type_module); \ + \ + return plugin_loader_name##_get_type(); \ +} + +G_END_DECLS + +#endif /* __GPE_PLUGIN_LOADER_H__ */ diff --git a/libgpe/gpe-plugin.c b/libgpe/gpe-plugin.c new file mode 100644 index 0000000..959c279 --- /dev/null +++ b/libgpe/gpe-plugin.c @@ -0,0 +1,277 @@ +/* + * gpe-plugin.h + * This file is part of libgpe + * + * Copyright (C) 2002-2005 Paolo Maggi + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifdef HAVE_CONFIG_H +#include <config.h> +#endif + +#include "gpe-plugin.h" +#include "gpe-dirs.h" + +/* properties */ +enum { + PROP_0, + PROP_INSTALL_DIR, + PROP_DATA_DIR +}; + +typedef struct _GPEPluginPrivate GPEPluginPrivate; + +struct _GPEPluginPrivate +{ + gchar *install_dir; + gchar *data_dir; +}; + +#define GPE_PLUGIN_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), GPE_TYPE_PLUGIN, GPEPluginPrivate)) + +G_DEFINE_TYPE(GPEPlugin, gpe_plugin, G_TYPE_OBJECT) + +static void +dummy (GPEPlugin *plugin, GObject *target_object) +{ + /* Empty */ +} + +static GtkWidget * +create_configure_dialog (GPEPlugin *plugin) +{ + return NULL; +} + +static gboolean +is_configurable (GPEPlugin *plugin) +{ + return (GPE_PLUGIN_GET_CLASS (plugin)->create_configure_dialog != + create_configure_dialog); +} + +static void +gpe_plugin_get_property (GObject *object, + guint prop_id, + GValue *value, + GParamSpec *pspec) +{ + switch (prop_id) + { + case PROP_INSTALL_DIR: + g_value_take_string (value, gpe_plugin_get_install_dir (GPE_PLUGIN (object))); + break; + case PROP_DATA_DIR: + g_value_take_string (value, gpe_plugin_get_data_dir (GPE_PLUGIN (object))); + break; + default: + g_return_if_reached (); + } +} + +static void +gpe_plugin_set_property (GObject *object, + guint prop_id, + const GValue *value, + GParamSpec *pspec) +{ + GPEPluginPrivate *priv = GPE_PLUGIN_GET_PRIVATE (object); + + switch (prop_id) + { + case PROP_INSTALL_DIR: + priv->install_dir = g_value_dup_string (value); + break; + case PROP_DATA_DIR: + priv->data_dir = g_value_dup_string (value); + break; + default: + g_return_if_reached (); + } +} + +static void +gpe_plugin_finalize (GObject *object) +{ + GPEPluginPrivate *priv = GPE_PLUGIN_GET_PRIVATE (object); + + g_free (priv->install_dir); + g_free (priv->data_dir); + + G_OBJECT_CLASS (gpe_plugin_parent_class)->finalize (object); +} + +static void +gpe_plugin_class_init (GPEPluginClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + klass->activate = dummy; + klass->deactivate = dummy; + klass->update_ui = dummy; + + klass->create_configure_dialog = create_configure_dialog; + klass->is_configurable = is_configurable; + + object_class->get_property = gpe_plugin_get_property; + object_class->set_property = gpe_plugin_set_property; + object_class->finalize = gpe_plugin_finalize; + + g_object_class_install_property (object_class, + PROP_INSTALL_DIR, + g_param_spec_string ("install-dir", + "Install Directory", + "The directory where the plugin is installed", + NULL, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + + g_object_class_install_property (object_class, + PROP_DATA_DIR, + g_param_spec_string ("data-dir", + "Data Directory", + "The full path of the directory where the plugin should look for its data files", + NULL, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + + g_type_class_add_private (klass, sizeof (GPEPluginPrivate)); +} + +static void +gpe_plugin_init (GPEPlugin *plugin) +{ + /* Empty */ +} + +/** + * gpe_plugin_get_install_dir: + * @plugin: a #GPEPlugin + * + * Get the path of the directory where the plugin is installed. + * + * Return value: a newly allocated string with the path of the + * directory where the plugin is installed + */ +gchar * +gpe_plugin_get_install_dir (GPEPlugin *plugin) +{ + g_return_val_if_fail (GPE_IS_PLUGIN (plugin), NULL); + + return g_strdup (GPE_PLUGIN_GET_PRIVATE (plugin)->install_dir); +} + +/** + * gpe_plugin_get_data_dir: + * @plugin: a #GPEPlugin + * + * Get the path of the directory where the plugin should look for + * its data files. + * + * Return value: a newly allocated string with the path of the + * directory where the plugin should look for its data files + */ +gchar * +gpe_plugin_get_data_dir (GPEPlugin *plugin) +{ + g_return_val_if_fail (GPE_IS_PLUGIN (plugin), NULL); + + return g_strdup (GPE_PLUGIN_GET_PRIVATE (plugin)->data_dir); +} + +/** + * gpe_plugin_activate: + * @plugin: a #GPEPlugin + * @target_object: a #GObject + * + * Activates the plugin. + */ +void +gpe_plugin_activate (GPEPlugin *plugin, + GObject *target_object) +{ + g_return_if_fail (GPE_IS_PLUGIN (plugin)); + g_return_if_fail (G_IS_OBJECT (target_object)); + + GPE_PLUGIN_GET_CLASS (plugin)->activate (plugin, target_object); +} + +/** + * gpe_plugin_deactivate: + * @plugin: a #GPEPlugin + * @target_object: a #GObject + * + * Deactivates the plugin. + */ +void +gpe_plugin_deactivate (GPEPlugin *plugin, + GObject *target_object) +{ + g_return_if_fail (GPE_IS_PLUGIN (plugin)); + g_return_if_fail (G_IS_OBJECT (target_object)); + + GPE_PLUGIN_GET_CLASS (plugin)->deactivate (plugin, target_object); +} + +/** + * gpe_plugin_update_ui: + * @plugin: a #GPEPlugin + * @target_object: a #GObject + * + * Triggers an update of the user interface to take into account state changes + * caused by the plugin. + */ +void +gpe_plugin_update_ui (GPEPlugin *plugin, + GObject *target_object) +{ + g_return_if_fail (GPE_IS_PLUGIN (plugin)); + g_return_if_fail (G_IS_OBJECT (target_object)); + + GPE_PLUGIN_GET_CLASS (plugin)->update_ui (plugin, target_object); +} + +/** + * gpe_plugin_is_configurable: + * @plugin: a #GPEPlugin + * + * Whether the plugin is configurable. + * + * Returns: TRUE if the plugin is configurable: + */ +gboolean +gpe_plugin_is_configurable (GPEPlugin *plugin) +{ + g_return_val_if_fail (GPE_IS_PLUGIN (plugin), FALSE); + + return GPE_PLUGIN_GET_CLASS (plugin)->is_configurable (plugin); +} + +/** + * gpe_plugin_create_configure_dialog: + * @plugin: a #GPEPlugin + * + * Creates the configure dialog widget for the plugin. + * + * Returns: the configure dialog widget for the plugin. + */ +GtkWidget * +gpe_plugin_create_configure_dialog (GPEPlugin *plugin) +{ + g_return_val_if_fail (GPE_IS_PLUGIN (plugin), NULL); + + return GPE_PLUGIN_GET_CLASS (plugin)->create_configure_dialog (plugin); +} diff --git a/libgpe/gpe-plugin.h b/libgpe/gpe-plugin.h new file mode 100644 index 0000000..378fe3a --- /dev/null +++ b/libgpe/gpe-plugin.h @@ -0,0 +1,147 @@ +/* + * gpe-plugin.h + * This file is part of libgpe + * + * Copyright (C) 2002-2005 - Paolo Maggi + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef __GPE_PLUGIN_H__ +#define __GPE_PLUGIN_H__ + +#include <glib-object.h> + +#include <gtk/gtk.h> + +/* TODO: add a .h file that includes all the .h files normally needed to + * develop a plugin */ + +G_BEGIN_DECLS + +/* + * Type checking and casting macros + */ +#define GPE_TYPE_PLUGIN (gpe_plugin_get_type()) +#define GPE_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GPE_TYPE_PLUGIN, GPEPlugin)) +#define GPE_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GPE_TYPE_PLUGIN, GPEPluginClass)) +#define GPE_IS_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GPE_TYPE_PLUGIN)) +#define GPE_IS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GPE_TYPE_PLUGIN)) +#define GPE_PLUGIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GPE_TYPE_PLUGIN, GPEPluginClass)) + +/* + * Main object structure + */ +typedef struct _GPEPlugin GPEPlugin; + +struct _GPEPlugin +{ + GObject parent; +}; + +/* + * Class definition + */ +typedef void (*GPEFunc) (GPEPlugin *plugin, GObject *target_object); + +typedef struct _GPEPluginClass GPEPluginClass; + +struct _GPEPluginClass +{ + GObjectClass parent_class; + + /* Virtual public methods */ + + void (*activate) (GPEPlugin *plugin, + GObject *target_object); + void (*deactivate) (GPEPlugin *plugin, + GObject *target_object); + + void (*update_ui) (GPEPlugin *plugin, + GObject *target_object); + + GtkWidget *(*create_configure_dialog) + (GPEPlugin *plugin); + + /* Plugins should not override this, it's handled automatically by + the GPEPluginClass */ + gboolean (*is_configurable) + (GPEPlugin *plugin); + + /* Padding for future expansion */ + void (*_gpe_reserved1) (void); + void (*_gpe_reserved2) (void); + void (*_gpe_reserved3) (void); + void (*_gpe_reserved4) (void); +}; + +/* + * Public methods + */ +GType gpe_plugin_get_type (void) G_GNUC_CONST; + +gchar *gpe_plugin_get_install_dir (GPEPlugin *plugin); +gchar *gpe_plugin_get_data_dir (GPEPlugin *plugin); + +void gpe_plugin_activate (GPEPlugin *plugin, + GObject *target_object); +void gpe_plugin_deactivate (GPEPlugin *plugin, + GObject *target_object); + +void gpe_plugin_update_ui (GPEPlugin *plugin, + GObject *target_object); + +gboolean gpe_plugin_is_configurable (GPEPlugin *plugin); +GtkWidget *gpe_plugin_create_configure_dialog (GPEPlugin *plugin); + +/** + * GPE_REGISTER_TYPE_WITH_CODE(PARENT_TYPE, PluginName, plugin_name, CODE): + * + * Utility macro used to register plugins with additional code. + */ +#define GPE_REGISTER_TYPE_WITH_CODE(PARENT_TYPE, PluginName, plugin_name, CODE) \ + G_DEFINE_DYNAMIC_TYPE_EXTENDED (PluginName, \ + plugin_name, \ + PARENT_TYPE, \ + 0, \ + CODE) \ + \ +/* This is not very nice, but G_DEFINE_DYNAMIC wants it and our old macro \ + * did not support it */ \ +static void \ +plugin_name##_class_finalize (PluginName##Class *klass) \ +{ \ +} \ + \ +G_MODULE_EXPORT GType \ +register_gpe_plugin (GTypeModule *type_module) \ +{ \ + plugin_name##_register_type (type_module); \ + \ + return plugin_name##_get_type(); \ +} + +/** + * GPE_REGISTER_TYPE(PARENT_TYPE, PluginName, plugin_name): + * + * Utility macro used to register plugins. + */ +#define GPE_REGISTER_TYPE(PARENT_TYPE, PluginName, plugin_name) \ + GPE_REGISTER_TYPE_WITH_CODE(PARENT_TYPE, PluginName, plugin_name, ;) + +G_END_DECLS + +#endif /* __GPE_PLUGIN_H__ */ diff --git a/loaders/Makefile.am b/loaders/Makefile.am new file mode 100644 index 0000000..6f20b92 --- /dev/null +++ b/loaders/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = c diff --git a/loaders/c/Makefile.am b/loaders/c/Makefile.am new file mode 100644 index 0000000..bfd0dd7 --- /dev/null +++ b/loaders/c/Makefile.am @@ -0,0 +1,16 @@ +# C plugin loader + +loaderdir = $(libdir)/libgpe-2.0/loaders + +INCLUDES = \ + -I$(top_srcdir) \ + $(GPE_CFLAGS) + +loader_LTLIBRARIES = libcloader.la + +libcloader_la_SOURCES = \ + gpe-plugin-loader-c.c \ + gpe-plugin-loader-c.h + +libcloader_la_LDFLAGS = $(LOADER_LIBTOOL_FLAGS) +libcloader_la_LIBADD = $(GPE_LIBS) diff --git a/loaders/c/gpe-plugin-loader-c.c b/loaders/c/gpe-plugin-loader-c.c new file mode 100644 index 0000000..626109b --- /dev/null +++ b/loaders/c/gpe-plugin-loader-c.c @@ -0,0 +1,179 @@ +/* + * gpe-plugin-loader-c.c + * This file is part of libgpe + * + * Copyright (C) 2008 - Jesse van den Kieboom + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#include "gpe-plugin-loader-c.h" +#include <libgpe/gpe-object-module.h> + +#define GPE_PLUGIN_LOADER_C_GET_PRIVATE(object) (G_TYPE_INSTANCE_GET_PRIVATE((object), GPE_TYPE_PLUGIN_LOADER_C, GPEPluginLoaderCPrivate)) + +struct _GPEPluginLoaderCPrivate +{ + GHashTable *loaded_plugins; +}; + +static void gpe_plugin_loader_iface_init (gpointer g_iface, gpointer iface_data); + +GPE_PLUGIN_LOADER_REGISTER_TYPE (GPEPluginLoaderC, gpe_plugin_loader_c, G_TYPE_OBJECT, gpe_plugin_loader_iface_init); + +static const gchar * +gpe_plugin_loader_iface_get_id (void) +{ + return "C"; +} + +static GPEPlugin * +gpe_plugin_loader_iface_load (GPEPluginLoader *loader, + GPEPluginInfo *info, + const gchar *path, + const gchar *datadir) +{ + GPEPluginLoaderC *cloader = GPE_PLUGIN_LOADER_C (loader); + GPEObjectModule *module; + const gchar *module_name; + GPEPlugin *result; + + module = (GPEObjectModule *) g_hash_table_lookup (cloader->priv->loaded_plugins, info); + module_name = gpe_plugin_info_get_module_name (info); + + if (module == NULL) + { + /* For now we force all modules to be resident */ + module = gpe_object_module_new (module_name, + path, + "register_gpe_plugin", + TRUE); + + /* Infos are available for all the lifetime of the loader. + * If this changes, we should use weak refs or something */ + + g_hash_table_insert (cloader->priv->loaded_plugins, info, module); + } + + if (!g_type_module_use (G_TYPE_MODULE (module))) + { + g_warning ("Could not load plugin module: %s", gpe_plugin_info_get_name (info)); + + return NULL; + } + + result = (GPEPlugin *) gpe_object_module_new_object (module, + "install-dir", path, + "data-dir", datadir, + NULL); + + if (!result) + { + g_warning ("Could not create plugin object: %s", gpe_plugin_info_get_name (info)); + g_type_module_unuse (G_TYPE_MODULE (module)); + + return NULL; + } + + g_type_module_unuse (G_TYPE_MODULE (module)); + + return result; +} + +static void +gpe_plugin_loader_iface_unload (GPEPluginLoader *loader, + GPEPluginInfo *info) +{ + //GPEPluginLoaderC *cloader = GPE_PLUGIN_LOADER_C (loader); + + /* this is a no-op, since the type module will be properly unused as + the last reference to the plugin dies. When the plugin is activated + again, the library will be reloaded */ +} + +static void +gpe_plugin_loader_iface_init (gpointer g_iface, + gpointer iface_data) +{ + GPEPluginLoaderInterface *iface = (GPEPluginLoaderInterface *) g_iface; + + iface->get_id = gpe_plugin_loader_iface_get_id; + iface->load = gpe_plugin_loader_iface_load; + iface->unload = gpe_plugin_loader_iface_unload; +} + +static void +gpe_plugin_loader_c_finalize (GObject *object) +{ + GPEPluginLoaderC *cloader = GPE_PLUGIN_LOADER_C (object); + GList *infos; + GList *item; + + /* FIXME: this sanity check it's not efficient. Let's remove it + * once we are confident with the code */ + + infos = g_hash_table_get_keys (cloader->priv->loaded_plugins); + + for (item = infos; item; item = item->next) + { + GPEPluginInfo *info = (GPEPluginInfo *) item->data; + + if (gpe_plugin_info_is_active (info)) + { + g_warning ("There are still C plugins loaded during destruction"); + break; + } + } + + g_list_free (infos); + + g_hash_table_destroy (cloader->priv->loaded_plugins); + + G_OBJECT_CLASS (gpe_plugin_loader_c_parent_class)->finalize (object); +} + +static void +gpe_plugin_loader_c_class_init (GPEPluginLoaderCClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + + object_class->finalize = gpe_plugin_loader_c_finalize; + + g_type_class_add_private (object_class, sizeof (GPEPluginLoaderCPrivate)); +} + +static void +gpe_plugin_loader_c_class_finalize (GPEPluginLoaderCClass *klass) +{ +} + +static void +gpe_plugin_loader_c_init (GPEPluginLoaderC *self) +{ + self->priv = GPE_PLUGIN_LOADER_C_GET_PRIVATE (self); + + /* loaded_plugins maps GPEPluginInfo to a GPEObjectModule */ + self->priv->loaded_plugins = g_hash_table_new (g_direct_hash, + g_direct_equal); +} + +GPEPluginLoaderC * +gpe_plugin_loader_c_new () +{ + GObject *loader = g_object_new (GPE_TYPE_PLUGIN_LOADER_C, NULL); + + return GPE_PLUGIN_LOADER_C (loader); +} diff --git a/loaders/c/gpe-plugin-loader-c.h b/loaders/c/gpe-plugin-loader-c.h new file mode 100644 index 0000000..9cf1579 --- /dev/null +++ b/loaders/c/gpe-plugin-loader-c.h @@ -0,0 +1,59 @@ +/* + * gpe-plugin-loader-c.h + * This file is part of libgpe + * + * Copyright (C) 2008 - Jesse van den Kieboom + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef __GPE_PLUGIN_LOADER_C_H__ +#define __GPE_PLUGIN_LOADER_C_H__ + +#include <libgpe/gpe-plugin-loader.h> + +G_BEGIN_DECLS + +#define GPE_TYPE_PLUGIN_LOADER_C (gpe_plugin_loader_c_get_type ()) +#define GPE_PLUGIN_LOADER_C(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GPE_TYPE_PLUGIN_LOADER_C, GPEPluginLoaderC)) +#define GPE_PLUGIN_LOADER_C_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GPE_TYPE_PLUGIN_LOADER_C, GPEPluginLoaderCClass)) +#define GPE_PLUGIN_IS_LOADER_C(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GPE_TYPE_PLUGIN_LOADER_C)) +#define GPE_PLUGIN_IS_LOADER_C_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GPE_TYPE_PLUGIN_LOADER_C)) +#define GPE_PLUGIN_LOADER_C_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GPE_TYPE_PLUGIN_LOADER_C, GPEPluginLoaderCClass)) + +typedef struct _GPEPluginLoaderC GPEPluginLoaderC; +typedef struct _GPEPluginLoaderCClass GPEPluginLoaderCClass; +typedef struct _GPEPluginLoaderCPrivate GPEPluginLoaderCPrivate; + +struct _GPEPluginLoaderC { + GObject parent; + + GPEPluginLoaderCPrivate *priv; +}; + +struct _GPEPluginLoaderCClass { + GObjectClass parent_class; +}; + +GType gpe_plugin_loader_c_get_type (void) G_GNUC_CONST; +GPEPluginLoaderC *gpe_plugin_loader_c_new(void); + +/* All the loaders must implement this function */ +G_MODULE_EXPORT GType register_gpe_plugin_loader (GTypeModule * module); + +G_END_DECLS + +#endif /* __GPE_PLUGIN_LOADER_C_H__ */ diff --git a/po/LINGUAS b/po/LINGUAS new file mode 100644 index 0000000..3e0724b --- /dev/null +++ b/po/LINGUAS @@ -0,0 +1,3 @@ +# +# libgpe translations +# please keep this list sorted alphabetically diff --git a/po/POTFILES.in b/po/POTFILES.in new file mode 100644 index 0000000..143c455 --- /dev/null +++ b/po/POTFILES.in @@ -0,0 +1,9 @@ +# List of source files containing translatable strings. +# Please keep this file sorted alphabetically. +[encoding: UTF-8] +libgpe/gpe-dirs.c +libgpe/gpe-engine.c +libgpe/gpe-object-module.c +libgpe/gpe-plugin.c +libgpe/gpe-plugin-info.c +libgpe/gpe-plugin-loader.c diff --git a/po/POTFILES.skip b/po/POTFILES.skip new file mode 100644 index 0000000..0f7ba42 --- /dev/null +++ b/po/POTFILES.skip @@ -0,0 +1,2 @@ +# List of source files to skip. +# Please keep this file sorted alphabetically. |