gimp/app/core/gimptoolinfo.c
Michael Natterer a74a8997b4 devel-docs/Makefile.am new file documenting the core's include policy.
2002-05-03  Michael Natterer  <mitch@gimp.org>

	* devel-docs/Makefile.am
	* devel-docs/includes.txt: new file documenting the core's
	include policy.

	* HACKING: mention it here.

	* libgimptool/gimptooltypes.h: removed GimpToolOptions here.

	* app/core/core-types.h: and added it here. This is a temp hack
	needed because GimpToolInfo needs to know the GimpToolOptions
	type.

	* libgimpproxy/gimpproxytypes.h: regenerated.

	* libgimptool/gimptoolmodule.h: don't include gimptooltypes.h here...
	* libgimptool/gimptoolmodule.c: ...but here.

	* app/config/gimpconfig-params.c: include "libgimpbase/gimpbase.h"
	entirely, not single files from it.

	* app/core/gimp.c
	* app/core/gimpcontext.c
	* app/core/gimpcoreconfig.c
	* app/core/gimpdatafactory.c
	* app/core/gimpdocuments.c
	* app/core/gimpdrawable-blend.c
	* app/core/gimpdrawable-bucket-fill.c
	* app/core/gimpdrawable-offset.c
	* app/core/gimpdrawable-transform.c
	* app/core/gimpdrawable.c
	* app/core/gimpedit.c
	* app/core/gimpimage-convert.c
	* app/core/gimpimage-crop.c
	* app/core/gimpimage-duplicate.c
	* app/core/gimpimage-guides.c
	* app/core/gimpimage-mask.c
	* app/core/gimpimage-merge.c
	* app/core/gimpimage-new.c
	* app/core/gimpimage-projection.c
	* app/core/gimpimage-qmask.c
	* app/core/gimpimage-resize.c
	* app/core/gimpimage-scale.c
	* app/core/gimpimage.c
	* app/core/gimpitem.c
	* app/core/gimpmodules.c
	* app/core/gimppaintinfo.c
	* app/core/gimpparasite.c
	* app/core/gimppreviewcache.c
	* app/core/gimptoolinfo.c
	* app/core/gimpunit.c: include "core-types.h" and no other types file.

	* app/display/gimpdisplay.c
	* app/display/gimpdisplayshell-callbacks.c
	* app/display/gimpdisplayshell.c: include "tools/tools-types.h"
	instead of "libgimptool/gimptooltypes.h", warn about inclusion
	on "gui/gui-types.h"

	* app/file/file-open.c
	* app/file/file-save.c: don't include "libgimptool/gimptooltypes.h".

	* app/gui/about-dialog.c
	* app/gui/brush-select.c
	* app/gui/brushes-commands.c
	* app/gui/color-select.c
	* app/gui/data-commands.c
	* app/gui/device-status-dialog.c
	* app/gui/dialogs.c
	* app/gui/gradients-commands.c
	* app/gui/help-commands.c
	* app/gui/info-window.c
	* app/gui/palettes-commands.c
	* app/gui/patterns-commands.c
	* app/gui/resize-dialog.c
	* app/gui/tips-dialog.c
	* app/gui/tool-options-dialog.c: include "gui-types.h" and no
	other types file.

	* app/paint/gimpairbrush.c
	* app/paint/gimpclone.c
	* app/paint/gimpconvolve.c
	* app/paint/gimpdodgeburn.c
	* app/paint/gimperaser.c
	* app/paint/gimppaintbrush.c
	* app/paint/gimppaintcore-stroke.c
	* app/paint/gimppaintcore.c
	* app/paint/gimppaintoptions.c
	* app/paint/gimppencil.c
	* app/paint/gimpsmudge.c
	* app/paint/paint.c: include "paint-types.h" and no other types file.

	* app/pdb/pdb-types.h: don't include "libgimptool/gimptooltypes.h".

	* app/plug-in/plug-in-progress.c: warn about inclusion of
	"display/display-types.h"

	* app/tools/tools-types.h: include "libgimptool/gimptooltypes.h".

	* app/tools/gimpairbrushtool.c
	* app/tools/gimpbezierselecttool.c
	* app/tools/gimpblendtool.c
	* app/tools/gimpbrightnesscontrasttool.c
	* app/tools/gimpbucketfilltool.c
	* app/tools/gimpbycolorselecttool.c
	* app/tools/gimpclonetool.c
	* app/tools/gimpcolorbalancetool.c
	* app/tools/gimpcolorpickertool.c
	* app/tools/gimpconvolvetool.c
	* app/tools/gimpcroptool.c
	* app/tools/gimpcurvestool.c
	* app/tools/gimpdodgeburntool.c
	* app/tools/gimpdrawtool.c
	* app/tools/gimpeditselectiontool.c
	* app/tools/gimpellipseselecttool.c
	* app/tools/gimperasertool.c
	* app/tools/gimpfliptool.c
	* app/tools/gimpfreeselecttool.c
	* app/tools/gimpfuzzyselecttool.c
	* app/tools/gimphistogramtool.c
	* app/tools/gimphuesaturationtool.c
	* app/tools/gimpinktool.c
	* app/tools/gimplevelstool.c
	* app/tools/gimpmagnifytool.c
	* app/tools/gimpmeasuretool.c
	* app/tools/gimpmovetool.c
	* app/tools/gimppaintbrushtool.c
	* app/tools/gimppainttool.c
	* app/tools/gimppathtool.c
	* app/tools/gimppenciltool.c
	* app/tools/gimpperspectivetool.c
	* app/tools/gimpposterizetool.c
	* app/tools/gimprectselecttool.c
	* app/tools/gimprotatetool.c
	* app/tools/gimpscaletool.c
	* app/tools/gimpselectiontool.c
	* app/tools/gimpsheartool.c
	* app/tools/gimpsmudgetool.c
	* app/tools/gimptexttool.c
	* app/tools/gimpthresholdtool.c
	* app/tools/gimptoolcontrol.c
	* app/tools/gimptoolcontrol.h
	* app/tools/gimptransformtool.c
	* app/tools/gimpvectortool.c
	* app/tools/tools.c: include "tools-types.h" and no other types file,
	warn about inclusion of "gui/gui-types.h".

	* app/widgets/gimpcolorpanel.c
	* app/widgets/gimptoolbox-color-area.c: warn about inclusion of
	"gui/gui-types.h".

	* app/xcf/xcf-load.c
	* app/xcf/xcf.c: don't include "libgimptool/gimptooltypes.h".

	Split tool-safe-mode up in two files, one including libgimpproxy,
	one libgimp.

	* plug-ins/tools/Makefile.am
	* plug-ins/tools/tool-safe-mode-plug-in.[ch]: new files including
	libgimp/ stuff only.

	* plug-ins/tools/tool-safe-mode.[ch]: include libgimpproxy/ and
	libgimptool/ but don't include libgimp/ because of conflicting
	declarations.

	Unrelated:

	* app/tools/gimpclonetool.c: create the clone core so we don't crash.

	* app/gui/file-open-dialog.c: changed the way we create previews
	so that only out-of-date previews are created on a click in the
	preview area. Unconditional creation can still be forced by
	<Ctrl>+click. Changed the tooltip to document this.
2002-05-03 12:45:22 +00:00

330 lines
8.2 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 <string.h>
#include <glib-object.h>
#include "core-types.h"
#include "base/temp-buf.h"
#include "gimp.h"
#include "gimpcontainer.h"
#include "gimpcontext.h"
#include "gimppaintinfo.h"
#include "gimptoolinfo.h"
static void gimp_tool_info_class_init (GimpToolInfoClass *klass);
static void gimp_tool_info_init (GimpToolInfo *tool_info);
static void gimp_tool_info_finalize (GObject *object);
static TempBuf * gimp_tool_info_get_new_preview (GimpViewable *viewable,
gint width,
gint height);
static GimpDataClass *parent_class = NULL;
GType
gimp_tool_info_get_type (void)
{
static GType tool_info_type = 0;
if (! tool_info_type)
{
static const GTypeInfo tool_info_info =
{
sizeof (GimpToolInfoClass),
(GBaseInitFunc) NULL,
(GBaseFinalizeFunc) NULL,
(GClassInitFunc) gimp_tool_info_class_init,
NULL, /* class_finalize */
NULL, /* class_data */
sizeof (GimpToolInfo),
0, /* n_preallocs */
(GInstanceInitFunc) gimp_tool_info_init,
};
tool_info_type = g_type_register_static (GIMP_TYPE_DATA,
"GimpToolInfo",
&tool_info_info, 0);
}
return tool_info_type;
}
static void
gimp_tool_info_class_init (GimpToolInfoClass *klass)
{
GObjectClass *object_class;
GimpViewableClass *viewable_class;
object_class = G_OBJECT_CLASS (klass);
viewable_class = GIMP_VIEWABLE_CLASS (klass);
parent_class = g_type_class_peek_parent (klass);
object_class->finalize = gimp_tool_info_finalize;
viewable_class->get_new_preview = gimp_tool_info_get_new_preview;
}
static void
gimp_tool_info_init (GimpToolInfo *tool_info)
{
tool_info->tool_type = G_TYPE_NONE;
tool_info->blurb = NULL;
tool_info->help = NULL;
tool_info->menu_path = NULL;
tool_info->menu_accel = NULL;
tool_info->help_domain = NULL;
tool_info->help_data = NULL;
tool_info->stock_id = NULL;
tool_info->stock_pixbuf = NULL;
tool_info->context = NULL;
tool_info->tool_options = NULL;
tool_info->paint_info = NULL;
}
static void
gimp_tool_info_finalize (GObject *object)
{
GimpToolInfo *tool_info;
tool_info = GIMP_TOOL_INFO (object);
if (tool_info->blurb)
{
g_free (tool_info->blurb);
tool_info->blurb = NULL;
}
if (tool_info->help)
{
g_free (tool_info->help);
tool_info->blurb = NULL;
}
if (tool_info->menu_path)
{
g_free (tool_info->menu_path);
tool_info->menu_path = NULL;
}
if (tool_info->menu_accel)
{
g_free (tool_info->menu_accel);
tool_info->menu_accel = NULL;
}
if (tool_info->help_domain)
{
g_free (tool_info->help_domain);
tool_info->help_domain = NULL;
}
if (tool_info->help_data)
{
g_free (tool_info->help_data);
tool_info->help_data = NULL;
}
if (tool_info->stock_id)
{
g_object_unref (G_OBJECT (tool_info->stock_id));
tool_info->stock_id = NULL;
}
if (tool_info->stock_pixbuf)
{
g_object_unref (G_OBJECT (tool_info->stock_pixbuf));
tool_info->stock_pixbuf = NULL;
}
G_OBJECT_CLASS (parent_class)->finalize (object);
}
static TempBuf *
temp_buf_new_from_pixbuf (GdkPixbuf *pixbuf,
gint width,
gint height)
{
TempBuf *temp_buf;
gint pixbuf_width;
gint pixbuf_height;
gint bytes;
guchar transparent[4] = { 0, 0, 0, 0 };
guchar *p_data;
guchar *t_data;
gint y;
g_return_val_if_fail (GDK_IS_PIXBUF (pixbuf), NULL);
pixbuf_width = gdk_pixbuf_get_width (pixbuf);
pixbuf_height = gdk_pixbuf_get_height (pixbuf);
if (pixbuf_width != width || pixbuf_height != height)
{
GdkPixbuf *scaled_pixbuf;
scaled_pixbuf = gdk_pixbuf_scale_simple (pixbuf,
width, height,
GDK_INTERP_BILINEAR);
pixbuf = scaled_pixbuf;
}
else
{
g_object_ref (G_OBJECT (pixbuf));
}
bytes = gdk_pixbuf_get_n_channels (pixbuf);
temp_buf = temp_buf_new (width, height, bytes, 0, 0, transparent);
p_data = gdk_pixbuf_get_pixels (pixbuf);
t_data = temp_buf_data (temp_buf);
for (y = 0; y < height; y++)
{
memcpy (t_data, p_data, width * bytes);
p_data += gdk_pixbuf_get_rowstride (pixbuf);
t_data += width * bytes;
}
g_object_unref (G_OBJECT (pixbuf));
return temp_buf;
}
static TempBuf *
gimp_tool_info_get_new_preview (GimpViewable *viewable,
gint width,
gint height)
{
GimpToolInfo *tool_info;
tool_info = GIMP_TOOL_INFO (viewable);
return temp_buf_new_from_pixbuf (tool_info->stock_pixbuf, width, height);
}
GimpToolInfo *
gimp_tool_info_new (Gimp *gimp,
GimpContext *context,
GType tool_type,
gboolean tool_context,
const gchar *identifier,
const gchar *blurb,
const gchar *help,
const gchar *menu_path,
const gchar *menu_accel,
const gchar *help_domain,
const gchar *help_data,
const gchar *paint_core_name,
const gchar *stock_id,
GdkPixbuf *stock_pixbuf)
{
GimpPaintInfo *paint_info;
GimpToolInfo *tool_info;
g_return_val_if_fail (GIMP_IS_GIMP (gimp), NULL);
g_return_val_if_fail (GIMP_IS_CONTEXT (context), NULL);
g_return_val_if_fail (identifier != NULL, NULL);
g_return_val_if_fail (blurb != NULL, NULL);
g_return_val_if_fail (help != NULL, NULL);
g_return_val_if_fail (menu_path != NULL, NULL);
g_return_val_if_fail (paint_core_name != NULL, NULL);
g_return_val_if_fail (stock_id != NULL, NULL);
g_return_val_if_fail (! stock_pixbuf || GDK_IS_PIXBUF (stock_pixbuf), NULL);
paint_info = (GimpPaintInfo *)
gimp_container_get_child_by_name (gimp->paint_info_list, paint_core_name);
g_return_val_if_fail (GIMP_IS_PAINT_INFO (paint_info), NULL);
tool_info = g_object_new (GIMP_TYPE_TOOL_INFO,
"name", identifier,
NULL);
tool_info->paint_info = paint_info;
if (tool_context)
{
tool_info->context = gimp_context_new (gimp,
identifier,
context);
}
tool_info->gimp = gimp;
tool_info->tool_type = tool_type;
tool_info->blurb = g_strdup (blurb);
tool_info->help = g_strdup (help);
tool_info->menu_path = g_strdup (menu_path);
tool_info->menu_accel = g_strdup (menu_accel);
tool_info->help_domain = g_strdup (help_domain);
tool_info->help_data = g_strdup (help_data);
tool_info->stock_id = g_strdup (stock_id);
tool_info->stock_pixbuf = stock_pixbuf;
if (stock_pixbuf)
g_object_ref (G_OBJECT (stock_pixbuf));
return tool_info;
}
void
gimp_tool_info_set_standard (Gimp *gimp,
GimpToolInfo *tool_info)
{
g_return_if_fail (GIMP_IS_GIMP (gimp));
g_return_if_fail (! tool_info || GIMP_IS_TOOL_INFO (tool_info));
if (gimp->standard_tool_info)
{
g_object_unref (G_OBJECT (gimp->standard_tool_info));
}
gimp->standard_tool_info = tool_info;
if (gimp->standard_tool_info)
{
g_object_ref (G_OBJECT (gimp->standard_tool_info));
}
}
GimpToolInfo *
gimp_tool_info_get_standard (Gimp *gimp)
{
g_return_val_if_fail (GIMP_IS_GIMP (gimp), NULL);
return gimp->standard_tool_info;
}