gimp/app/pdb/gimppluginprocedure.c
Michael Natterer 1f2c75e507 Completed the new help infrastructure. Needs some polishing but basically
2003-08-28  Michael Natterer  <mitch@gimp.org>

	Completed the new help infrastructure. Needs some polishing but
	basically works as proposed:

	* tools/pdbgen/pdb/plug_in.pdb: changed gimp_plugin_help_register()
	to take a "domain_name" (which is the XML namespace) and a
	"domain_uri" (which is the root of the plug-in's help pages).

	* tools/pdbgen/pdb/help.pdb: changed gimp_help() to take help_id
	instead of a non-UTF-8 help_path.

	* app/plug-in/plug-in-def.[ch]
	* app/plug-in/plug-in-proc.[ch]
	* app/plug-in/plug-in-rc.c
	* app/plug-in/plug-ins.[ch]: remember the plug-ins' help_domain
	and help_uri instead of just help_path. Changed all plug-in APIs
	to reflect this change.

	* app/widgets/gimphelp.[ch]: on helpbrowser startup, pass it the
	whole list of help domains. The actual help request is now made
	using the browser's temporary procedure.

	* app/core/gimp.h
	* app/gui/file-open-menu.c
	* app/gui/file-save-menu.c
	* app/gui/plug-in-menus.[ch]
	* app/widgets/gimpitemfactory.c: changed accordingly.

	* app/pdb/help_cmds.c
	* app/pdb/plug_in_cmds.c
	* libgimp/gimphelp_pdb.[ch]
	* libgimp/gimpplugin_pdb.[ch]: regenerated.

	Changed the help broser to load the pages according to the
	new system:

	- moved the browser window stuff to dialog.[ch]
	- moved help domain handling to domain.[ch]
	- added gimp-help.xml parsing to domain.c
	- tons of cleanup

	* plug-ins/helpbrowser/Makefile.am
	* plug-ins/helpbrowser/dialog.[ch]
	* plug-ins/helpbrowser/domain.[ch]: new files.
	* plug-ins/helpbrowser/helpbrowser.c: chopped.
2003-08-28 18:49:11 +00:00

135 lines
3.1 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.
*/
#include "config.h"
#include <glib-object.h>
#include "plug-in-types.h"
#include "plug-in.h"
#include "plug-in-proc.h"
PlugInProcDef *
plug_in_proc_def_new (void)
{
PlugInProcDef *proc_def;
proc_def = g_new0 (PlugInProcDef, 1);
return proc_def;
}
void
plug_in_proc_def_free (PlugInProcDef *proc_def)
{
gint i;
g_return_if_fail (proc_def != NULL);
g_free (proc_def->db_info.name);
g_free (proc_def->db_info.blurb);
g_free (proc_def->db_info.help);
g_free (proc_def->db_info.author);
g_free (proc_def->db_info.copyright);
g_free (proc_def->db_info.date);
for (i = 0; i < proc_def->db_info.num_args; i++)
{
g_free (proc_def->db_info.args[i].name);
g_free (proc_def->db_info.args[i].description);
}
for (i = 0; i < proc_def->db_info.num_values; i++)
{
g_free (proc_def->db_info.values[i].name);
g_free (proc_def->db_info.values[i].description);
}
g_free (proc_def->db_info.args);
g_free (proc_def->db_info.values);
g_free (proc_def->prog);
g_free (proc_def->menu_path);
g_free (proc_def->accelerator);
g_free (proc_def->extensions);
g_free (proc_def->prefixes);
g_free (proc_def->magics);
g_free (proc_def->image_types);
g_free (proc_def);
}
ProcRecord *
plug_in_proc_def_get_proc (PlugInProcDef *proc_def)
{
g_return_val_if_fail (proc_def != NULL, NULL);
return &proc_def->db_info;
}
const gchar *
plug_in_proc_def_get_progname (PlugInProcDef *proc_def)
{
g_return_val_if_fail (proc_def != NULL, NULL);
switch (proc_def->db_info.proc_type)
{
case GIMP_PLUGIN:
case GIMP_EXTENSION:
return proc_def->prog;
case GIMP_TEMPORARY:
return ((PlugIn *) proc_def->db_info.exec_method.temporary.plug_in)->prog;
default:
break;
}
return NULL;
}
gchar *
plug_in_proc_def_get_help_id (PlugInProcDef *proc_def,
const gchar *help_domain)
{
gchar *help_id;
gchar *p;
g_return_val_if_fail (proc_def != NULL, NULL);
help_id = g_strdup (proc_def->db_info.name);
for (p = help_id; p && *p; p++)
if (*p == '_')
*p = '-';
if (help_domain)
{
gchar *domain_and_id;
domain_and_id = g_strconcat (help_domain, "?", help_id, NULL);
g_free (help_id);
return domain_and_id;
}
return help_id;
}