dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
gimp/libgimp/gimpplugin-private.h

61 lines
2.6 KiB
C
Raw Normal View History

libgimp: add initial version of a GimpPlugIn class The new way of doing plug-ins: - subclass GimpPlugIn in your plug-in - implement its query() and run() methods, run() will move to a new GimpProcedure class soon - instead of MAIN(), say GIMP_MAIN(YOUR_PLUG_IN_TYPE) Instead of keeping around a GimpPlugInInfo struct, libgimp will create an instance of your plug-in class, keep it around during the plug-in's lifetime, and call its virtual functions.
2019-07-26 05:07:24 +08:00
/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
*
* gimpplugin-private.h
app, libgimp: add copyright notices to the new stuff, minor cleanup
2019-07-31 06:12:36 +08:00
* Copyright (C) 2019 Michael Natterer <mitch@gimp.org>
libgimp: add initial version of a GimpPlugIn class The new way of doing plug-ins: - subclass GimpPlugIn in your plug-in - implement its query() and run() methods, run() will move to a new GimpProcedure class soon - instead of MAIN(), say GIMP_MAIN(YOUR_PLUG_IN_TYPE) Instead of keeping around a GimpPlugInInfo struct, libgimp will create an instance of your plug-in class, keep it around during the plug-in's lifetime, and call its virtual functions.
2019-07-26 05:07:24 +08:00
*
* This library is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see
* <https://www.gnu.org/licenses/>.
*/
#ifndef __GIMP_PLUG_IN_PRIVATE_H__
#define __GIMP_PLUG_IN_PRIVATE_H__
G_BEGIN_DECLS
app, libgimp, libgimpbase: plug-in and PDB protocol refactoring part two - Change the wire protocol's GPProcInstall to transmit the entire information needed for constructing all GParamSpecs we use, don't use GimpPDBArgType in GPProcInstall but an enum private to the wire protocol plus the GParamSpec's GType name. Bump the wire protocol version. - Add gimpgpparamspecs.[ch] in both app/plug-in/ and libgimp/ which take care of converting between GPParamDef and GParamSpec. They share code as far as possible. - Change pluginrc writing and parsing to re-use GPParamDef and the utility functions from gimpgpparamspecs. - Remove gimp_pdb_compat_param_spec() from app/pdb/gimp-pdb-compat.[ch], the entire core uses proper GParamSpecs from the wire protocol now, the whole file will follow down the drain once we use a GValue representation on the wire too. - In gimp_plug_in_handle_proc_install(), change the "run-mode" parameter to a GParamSpecEnum(GIMP_TYPE_RUN_MODE) (if it is not already an enum). and change all places in app/ to treat it as an enum value. - plug-ins: fix cml-explorer to register correctly, a typo in "run-mode" was never noticed until now. - Add gimpgpcompat.[ch] in libgimp to deal with all the transforms between old-style wire communication and using GParamSpec and GValue, it contains some functions that are subject to change or even removal in the next steps. - Change the libgimp GimpProcedure and GimpPlugIn in many ways to be able to actually install procedures the new way. - plug-ins: change goat-exercise to completely use the new GimpPlugIn and GimpProcedure API, look here to see how plug-ins will look in the future, of course subject to change until this is finished. - Next: changing GPParam to transmit all information about a GValue.
2019-07-27 22:37:55 +08:00
libgimp: memory/lifecycle manage the new libgmp proxy objects Turn GimpPlugIn into the main factory for all proxies and keep the main hash tables there. The hash tables keep the initial reference. For each GimpProcedure::run(), have s "sub-factory" which hands out proxies to the actual procedure code. Each run() has hash tables of its own which hold additional references. When run() is done, get rid of its hash tables and their references, *and* drop the main plug-in reference counts from the global hashes if the proxies' refcount has dropped to one.
2019-08-23 23:18:17 +08:00
void _gimp_plug_in_query (GimpPlugIn *plug_in);
void _gimp_plug_in_init (GimpPlugIn *plug_in);
void _gimp_plug_in_run (GimpPlugIn *plug_in);
void _gimp_plug_in_quit (GimpPlugIn *plug_in);
GIOChannel * _gimp_plug_in_get_read_channel (GimpPlugIn *plug_in);
GIOChannel * _gimp_plug_in_get_write_channel (GimpPlugIn *plug_in);
void _gimp_plug_in_read_expect_msg (GimpPlugIn *plug_in,
GimpWireMessage *msg,
gint type);
libgimp: add a new set_i18n() method to GimpPlugIn class. Clearly the old logic for localizing plug-ins was "core plug-ins first": * In particular, we were defaulting to the "gimp*-std-plugins" domain, asking plug-ins to override it with libgimp function gimp_plug_in_set_translation_domain(). Obviously any third-party plug-in would have to call this function since their strings are most likely not the same as GIMP core plug-ins. * Moreover this was only for the localization of menu items, which means we had to duplicate work anyway (simplified for core C plug-ins only with the INIT_I18N macro). * Also plug-ins had to manage the location of the Gettext catalogs, which is simpler for core plug-ins with gimp_locale_directory(), but more annoying for third-party plug-ins which can be installed basically anywhere (assuming their message catalogs are in their directory, not centrally installed on the system, especially for non-UNIX-like packages, with relocatable GIMP, no central package system and so on). * Finally in this logic of centrally installed catalogs, we were requesting that the domain name is unique, which makes sense in a Linux world with well maintained packages to avoid name clashes, not in a world with people making plug-ins without knowing too much what's done by their neighbour. So now the new logic is: - By default, GIMP will search for a folder called locale/ on the same level as the plug-in executable. The Gettext domain will be the name of the executable folder (and it doesn't matter too much if it's not unique in such configuration). - This can be disabled by overriding set_i18n() to NULL or reimplementing it. All our core plug-ins will do this since they will continue to use the centrally installed "gimp*-std-plugins" domain (or "gimp*-python" for Python plug-ins). - When not disabled while the folder is not available, warning messages will be outputted to stderr, so that plug-in developers can easily detect what is missing and how to handle it (and how to easily support internationalization of their plug-in). - gimp_plug_in_set_translation_domain() is removed and a future commit is going to get rid of _gimp_plug_in_domain_register() because we are going to get rid of the core-side localization of menu items (with logic explained in the upcoming commit).
2022-05-26 06:39:32 +08:00
gboolean _gimp_plug_in_set_i18n (GimpPlugIn *plug_in,
const gchar *procedure_name,
gchar **gettext_domain,
gchar **catalog_dir);
libgimp: remove gimp_plug_in_create_procedure() from the API no plug-in code ever needs to call it.
2019-09-10 18:11:32 +08:00
GimpProcedure * _gimp_plug_in_create_procedure (GimpPlugIn *plug_in,
const gchar *procedure_name);
libgimp: memory/lifecycle manage the new libgmp proxy objects Turn GimpPlugIn into the main factory for all proxies and keep the main hash tables there. The hash tables keep the initial reference. For each GimpProcedure::run(), have s "sub-factory" which hands out proxies to the actual procedure code. Each run() has hash tables of its own which hold additional references. When run() is done, get rid of its hash tables and their references, *and* drop the main plug-in reference counts from the global hashes if the proxies' refcount has dropped to one.
2019-08-23 23:18:17 +08:00
GimpProcedure * _gimp_plug_in_get_procedure (GimpPlugIn *plug_in);
GimpDisplay * _gimp_plug_in_get_display (GimpPlugIn *plug_in,
gint32 display_id);
GimpImage * _gimp_plug_in_get_image (GimpPlugIn *plug_in,
gint32 image_id);
GimpItem * _gimp_plug_in_get_item (GimpPlugIn *plug_in,
gint32 item_id);
libgimp: name parameters "procedure_name" not just "name" and some random cleanup.
2019-08-07 16:43:07 +08:00
libgimp: add initial version of a GimpPlugIn class The new way of doing plug-ins: - subclass GimpPlugIn in your plug-in - implement its query() and run() methods, run() will move to a new GimpProcedure class soon - instead of MAIN(), say GIMP_MAIN(YOUR_PLUG_IN_TYPE) Instead of keeping around a GimpPlugInInfo struct, libgimp will create an instance of your plug-in class, keep it around during the plug-in's lifetime, and call its virtual functions.
2019-07-26 05:07:24 +08:00
G_END_DECLS
#endif /* __GIMP_PLUG_IN_PRIVATE_H__ */