mirror of
https://gitlab.gnome.org/GNOME/gimp
synced 2024-10-20 19:43:01 +00:00
9c6b0b0c33
2000-05-21 Michael Natterer <mitch@gimp.org> These changes enable help support for 3rd party plug-ins which install their help files outside GIMP's main help dir. Instead of calling gimp_help(), gimp_plugin_help_func() etc., all help callbacks now have to call gimp_standard_help_func() which has different implementations in the app and in libgimp. There is a new function gimp_plugin_help_register() which can be called during plug-in query. plug_in.c keeps a list of executable_name/help_path pairs. Plug-ins have to pass their exec. name to gimp_help() which uses the list to find the plug-in's help directory. * app/gimphelp.[ch]: gimp_help() now takes a help_path parameter. help_path == NULL means the standard help directory. Various changes to pass the help_path to the help browser. * app/gimprc.c: save the plug-in's help_path in the pluginrc file. * app/menus.c: ugly hack to enable help_paths in the "F1" callback. * app/plug_in.[ch]: many help_path related changes. Use g_basename() instead of strrchr(str,G_DIR_SEPARATOR), cosmetic cleanups. * app/internal_procs.c * app/gimphelp_cmds.c * tools/pdbgen/pdb/gimphelp.pdb: new procedure gimp_plugin_help_register(). gimp_help() takes a second parameter which is the executable name (not the help_path). * app/color_notebook.c * app/commands.c * app/lc_dialog.c * app/preferences_dialog.c * app/tools.c: call gimp_standard_help_func() instead of gimp_help(). * libgimp/gimp.c: new function gimp_get_progname() which returns the full path of the plug-in's executable. * libgimp/gimp.h: export the new function, removed gimp_plugin_help_func(), gimp_help() takes the executable name as second parameter. * libgimp/gimpcompat.h: added gimp_plugin_help_func(). * libgimp/gimphelp.c: a wrapper for gimp_plugin_help_register(), changed the calls to gimp_help. * libgimp/gimphelpui.[ch]: call gimp_standard_help_func() instead of gimp_help(). * plug-ins/helpbrowser/helpbrowser.c: now called with an additional help_path parameter. Various changes to enable help_path != gimp_standard_help_path. Unrelated stuff: * app/batch.h: added missing GPL header. * app/gimpunit.c: had a LGPL header, merged some fprintf's into one call. * app/procedural_db.[ch]: cosmetic: g* types, s/g_malloc/g_new/, prototypes, indentation. * app/resize.c: use less packing widgets. didn't find the "offset" redraw bug :(
196 lines
6.5 KiB
C
196 lines
6.5 KiB
C
/* The GIMP -- an image manipulation program
|
|
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
|
|
*
|
|
* 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 __PLUG_IN_H__
|
|
#define __PLUG_IN_H__
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <gtk/gtk.h>
|
|
|
|
#include "procedural_db.h"
|
|
#include "gimpprogress.h"
|
|
#include "drawable.h"
|
|
|
|
#define WRITE_BUFFER_SIZE 512
|
|
|
|
#define PLUG_IN_RGB_IMAGE 0x01
|
|
#define PLUG_IN_GRAY_IMAGE 0x02
|
|
#define PLUG_IN_INDEXED_IMAGE 0x04
|
|
#define PLUG_IN_RGBA_IMAGE 0x08
|
|
#define PLUG_IN_GRAYA_IMAGE 0x10
|
|
#define PLUG_IN_INDEXEDA_IMAGE 0x20
|
|
|
|
|
|
typedef enum
|
|
{
|
|
RUN_INTERACTIVE = 0,
|
|
RUN_NONINTERACTIVE = 1,
|
|
RUN_WITH_LAST_VALS = 2
|
|
} RunModeType;
|
|
|
|
|
|
struct _PlugIn
|
|
{
|
|
guint open : 1; /* Is the plug-in open* */
|
|
guint destroy : 1; /* Should the plug-in by destroyed* */
|
|
guint query : 1; /* Are we querying the plug-in? */
|
|
guint synchronous : 1; /* Is the plug-in running synchronously? */
|
|
guint recurse : 1; /* Have we called 'gtk_main' recursively? */
|
|
guint busy : 1; /* Is the plug-in busy with a temp proc? */
|
|
pid_t pid; /* Plug-ins process id */
|
|
gchar *args[7]; /* Plug-ins command line arguments */
|
|
|
|
GIOChannel *my_read; /* App's read and write channels */
|
|
GIOChannel *my_write;
|
|
GIOChannel *his_read; /* Plug-in's read and write channels */
|
|
GIOChannel *his_write;
|
|
#ifdef G_OS_WIN32
|
|
guint his_thread_id; /* Plug-in's thread ID */
|
|
gint his_read_fd; /* Plug-in's read pipe fd */
|
|
#endif
|
|
|
|
guint32 input_id; /* Id of input proc */
|
|
|
|
gchar write_buffer[WRITE_BUFFER_SIZE]; /* Buffer for writing */
|
|
gint write_buffer_index; /* Buffer index for writing */
|
|
|
|
GSList *temp_proc_defs; /* Temporary procedures */
|
|
|
|
gimp_progress *progress; /* Progress dialog */
|
|
|
|
gpointer user_data; /* Handle for hanging data onto */
|
|
};
|
|
|
|
struct _PlugInDef
|
|
{
|
|
gchar *prog;
|
|
GSList *proc_defs;
|
|
gchar *locale_domain;
|
|
gchar *locale_path;
|
|
gchar *help_path;
|
|
time_t mtime;
|
|
gboolean query;
|
|
};
|
|
|
|
struct _PlugInProcDef
|
|
{
|
|
gchar *prog;
|
|
gchar *menu_path;
|
|
gchar *accelerator;
|
|
gchar *extensions;
|
|
gchar *prefixes;
|
|
gchar *magics;
|
|
gchar *image_types;
|
|
gint image_types_val;
|
|
ProcRecord db_info;
|
|
GSList *extensions_list;
|
|
GSList *prefixes_list;
|
|
GSList *magics_list;
|
|
time_t mtime;
|
|
};
|
|
|
|
|
|
/* Initialize the plug-ins */
|
|
void plug_in_init (void);
|
|
|
|
/* Kill all running plug-ins */
|
|
void plug_in_kill (void);
|
|
|
|
/* Add a plug-in to the list of valid plug-ins and query the plug-in
|
|
* for information if necessary.
|
|
*/
|
|
void plug_in_add (gchar *name,
|
|
gchar *menu_path,
|
|
gchar *accelerator);
|
|
|
|
/* Get the "image_types" the plug-in works on. */
|
|
gchar * plug_in_image_types (gchar *name);
|
|
|
|
/* Add in the file load/save handler fields procedure. */
|
|
PlugInProcDef * plug_in_file_handler (gchar *name,
|
|
gchar *extensions,
|
|
gchar *prefixes,
|
|
gchar *magics);
|
|
|
|
/* Add a plug-in definition. */
|
|
void plug_in_def_add (PlugInDef *plug_in_def);
|
|
|
|
/* Allocate and free a plug-in definition. */
|
|
PlugInDef * plug_in_def_new (gchar *prog);
|
|
void plug_in_def_free (PlugInDef *plug_in_def,
|
|
gboolean free_proc_defs);
|
|
|
|
/* Retrieve a plug-ins menu path */
|
|
gchar * plug_in_menu_path (gchar *name);
|
|
|
|
/* Retrieve a plug-ins help path */
|
|
gchar * plug_in_help_path (gchar *prog_name);
|
|
|
|
/* Create a new plug-in structure */
|
|
PlugIn * plug_in_new (gchar *name);
|
|
|
|
/* Destroy a plug-in structure.
|
|
* This will close the plug-in first if necessary.
|
|
*/
|
|
void plug_in_destroy (PlugIn *plug_in);
|
|
|
|
/* Open a plug-in. This cause the plug-in to run.
|
|
* If returns TRUE, you must destroy the plugin.
|
|
* If returns FALSE, you must not destroy the plugin.
|
|
*/
|
|
gboolean plug_in_open (PlugIn *plug_in);
|
|
|
|
/* Close a plug-in. This kills the plug-in and releases its resources. */
|
|
void plug_in_close (PlugIn *plug_in,
|
|
gboolean kill_it);
|
|
|
|
/* Run a plug-in as if it were a procedure database procedure */
|
|
Argument * plug_in_run (ProcRecord *proc_rec,
|
|
Argument *args,
|
|
gint argc,
|
|
gboolean synchronous,
|
|
gboolean destroy_values,
|
|
gint gdisp_ID);
|
|
|
|
/* Run the last plug-in again with the same arguments. Extensions
|
|
* are exempt from this "privelege".
|
|
*/
|
|
void plug_in_repeat (gboolean with_interface);
|
|
|
|
/* Set the sensitivity for plug-in menu items based on the image type. */
|
|
void plug_in_set_menu_sensitivity (GimpImageType type);
|
|
|
|
/* Register an internal plug-in. This is for file load-save
|
|
* handlers, which are organized around the plug-in data structure.
|
|
* This could all be done a little better, but oh well. -josh
|
|
*/
|
|
void plug_in_add_internal (PlugInProcDef *proc_def);
|
|
GSList * plug_in_extensions_parse (gchar *extensions);
|
|
gint plug_in_image_types_parse (gchar *image_types);
|
|
|
|
void plug_in_progress_init (PlugIn *plug_in,
|
|
gchar *message,
|
|
gint gdisp_ID);
|
|
void plug_in_progress_update (PlugIn *plug_in,
|
|
gdouble percentage);
|
|
|
|
extern PlugIn *current_plug_in;
|
|
extern GSList *proc_defs;
|
|
|
|
#endif /* __PLUG_IN_H__ */
|