gimp/app/tools/gimptexttool.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 <stdlib.h>
#include <errno.h>

#include <gtk/gtk.h>
#include <pango/pangoft2.h>

#include "libgimpwidgets/gimpwidgets.h"

#include "tools-types.h"

#include "core/gimpimage.h"
#include "core/gimpimage-mask.h"
#include "core/gimpimage-text.h"
#include "core/gimplayer.h"
#include "core/gimplayer-floating-sel.h"
#include "core/gimptext.h"
#include "core/gimptoolinfo.h"

#include "widgets/gimpfontselection.h"
#include "widgets/gimpwidgets-utils.h"

#include "display/gimpdisplay.h"

#include "gimpeditselectiontool.h"
#include "gimptexttool.h"
#include "tool_options.h"

#include "gimprc.h"
#include "undo.h"

#include "libgimp/gimpintl.h"


#define DEFAULT_FONT       "sans Normal"
#define DEFAULT_FONT_SIZE  18


/*  the text tool structures  */

typedef struct _TextOptions TextOptions;

struct _TextOptions
{
  GimpToolOptions  tool_options;

  gchar           *fontname_d;
  GtkWidget       *font_selection;

  gdouble          size;
  gdouble          size_d;
  GtkObject       *size_w;

  gdouble          border;
  gdouble          border_d;
  GtkObject       *border_w;

  GimpUnit         unit;
  GimpUnit         unit_d;
  GtkWidget       *unit_w;

  gdouble          line_spacing;
  gdouble          line_spacing_d;
  GtkObject       *line_spacing_w;

  gdouble          letter_spacing;
  gdouble          letter_spacing_d;
  GtkObject       *letter_spacing_w;
};


/*  local function prototypes  */

static void     gimp_text_tool_class_init    (GimpTextToolClass *klass);
static void     gimp_text_tool_init          (GimpTextTool      *tool);

static void     gimp_text_tool_finalize      (GObject           *object);

static void     text_tool_control              (GimpTool        *tool,
                                                GimpToolAction   action,
                                                GimpDisplay     *gdisp);
static void     text_tool_button_press         (GimpTool        *tool,
                                                GimpCoords      *coords,
                                                guint32          time,
                                                GdkModifierType  state,
                                                GimpDisplay     *gdisp);
static void     text_tool_button_release       (GimpTool        *tool,
                                                GimpCoords      *coords,
                                                guint32          time,
                                                GdkModifierType  state,
                                                GimpDisplay     *gdisp);
static void     text_tool_cursor_update        (GimpTool        *tool,
                                                GimpCoords      *coords,
                                                GdkModifierType  state,
                                                GimpDisplay     *gdisp);

static void     text_tool_render               (GimpTextTool    *text_tool);

static GimpToolOptions * text_tool_options_new   (GimpToolInfo    *tool_info);
static void              text_tool_options_reset (GimpToolOptions *tool_options);

static void     text_tool_editor               (GimpTextTool    *text_tool);
static void     text_tool_editor_ok            (GimpTextTool    *text_tool);
static void     text_tool_editor_load          (GtkWidget       *widget,
                                                GimpTextTool    *text_tool);
static void     text_tool_editor_load_ok       (GimpTextTool    *text_tool);
static gboolean text_tool_load_file            (GtkTextBuffer   *buffer,
                                                const gchar     *filename);
static void     text_tool_editor_clear         (GtkWidget       *widget,
                                                GimpTextTool    *text_tool);

/*  local variables  */

static GimpToolClass *parent_class = NULL;


/*  public functions  */

void
gimp_text_tool_register (GimpToolRegisterCallback  callback,
                         gpointer                  data)
{
  (* callback) (GIMP_TYPE_TEXT_TOOL,
                text_tool_options_new,
                FALSE,
                "gimp-text-tool",
                _("Text Tool"),
                _("Add text to the image"),
                N_("/Tools/Text"), "T",
                NULL, "tools/text.html",
                GIMP_STOCK_TOOL_TEXT,
                data);
}

GType
gimp_text_tool_get_type (void)
{
  static GType tool_type = 0;

  if (! tool_type)
    {
      static const GTypeInfo tool_info =
      {
        sizeof (GimpTextToolClass),
	(GBaseInitFunc) NULL,
	(GBaseFinalizeFunc) NULL,
	(GClassInitFunc) gimp_text_tool_class_init,
	NULL,           /* class_finalize */
	NULL,           /* class_data     */
	sizeof (GimpTextTool),
	0,              /* n_preallocs    */
	(GInstanceInitFunc) gimp_text_tool_init,
      };

      tool_type = g_type_register_static (GIMP_TYPE_TOOL,
					  "GimpTextTool", 
                                          &tool_info, 0);
    }

  return tool_type;
}


/*  private functions  */

static void
gimp_text_tool_class_init (GimpTextToolClass *klass)
{
  GObjectClass  *object_class;
  GimpToolClass *tool_class;

  object_class = G_OBJECT_CLASS (klass);
  tool_class   = GIMP_TOOL_CLASS (klass);

  parent_class = g_type_class_peek_parent (klass);

  object_class->finalize     = gimp_text_tool_finalize;

  tool_class->control        = text_tool_control;
  tool_class->button_press   = text_tool_button_press;
  tool_class->button_release = text_tool_button_release;
  tool_class->cursor_update  = text_tool_cursor_update;
}

static void
gimp_text_tool_init (GimpTextTool *text_tool)
{
  GimpTool *tool = GIMP_TOOL (text_tool);
 
  text_tool->pango_context = pango_ft2_get_context (gimprc.monitor_xres,
                                                    gimprc.monitor_yres);

  text_tool->buffer = gtk_text_buffer_new (NULL);
  gtk_text_buffer_set_text (text_tool->buffer, "Eeek, it's The GIMP", -1);

  gimp_tool_control_set_scroll_lock (tool->control, TRUE);
  gimp_tool_control_set_tool_cursor (tool->control, GIMP_TEXT_TOOL_CURSOR);
}

static void
gimp_text_tool_finalize (GObject *object)
{
  GimpTextTool *text_tool = GIMP_TEXT_TOOL (object);

  if (text_tool->pango_context)
    {
      g_object_unref (text_tool->pango_context);
      text_tool->pango_context = NULL;
    }
  if (text_tool->buffer)
    {
      g_object_unref (text_tool->buffer);
      text_tool->buffer = NULL;
    }

  G_OBJECT_CLASS (parent_class)->finalize (object);
}

static void
text_tool_control (GimpTool       *tool,
		   GimpToolAction  action,
		   GimpDisplay    *gdisp)
{
  switch (action)
    {
    case PAUSE:
      break;

    case RESUME:
      break;

    case HALT:
      if (GIMP_TEXT_TOOL (tool)->editor)
        gtk_widget_destroy (GIMP_TEXT_TOOL (tool)->editor);
      break;

    default:
      break;
    }

  GIMP_TOOL_CLASS (parent_class)->control (tool, action, gdisp);
}

static void
text_tool_button_press (GimpTool        *tool,
                        GimpCoords      *coords,
                        guint32          time,
			GdkModifierType  state,
			GimpDisplay     *gdisp)
{
  GimpTextTool *text_tool;
  GimpLayer    *layer;

  text_tool = GIMP_TEXT_TOOL (tool);

  text_tool->gdisp = gdisp;

  gimp_tool_control_activate (tool->control);
  tool->gdisp = gdisp;

  text_tool->click_x = coords->x;
  text_tool->click_y = coords->y;

  if ((layer = gimp_image_pick_correlate_layer (gdisp->gimage,
                                                text_tool->click_x,
                                                text_tool->click_y)))
    /* if there is a floating selection, and this aint it, use the move tool */
    if (gimp_layer_is_floating_sel (layer))
      {
	init_edit_selection (tool, gdisp, coords, EDIT_LAYER_TRANSLATE);
	return;
      }

  text_tool_editor (text_tool);
}

static void
text_tool_button_release (GimpTool        *tool,
                          GimpCoords      *coords,
                          guint32          time,
			  GdkModifierType  state,
			  GimpDisplay     *gdisp)
{
  /* sets paused_count to 0 -- is this ok? */
  gimp_tool_control_halt (tool->control);
}

static void
text_tool_cursor_update (GimpTool        *tool,
                         GimpCoords      *coords,
			 GdkModifierType  state,
			 GimpDisplay     *gdisp)
{
  GimpLayer *layer;

  layer = gimp_image_pick_correlate_layer (gdisp->gimage,
                                           coords->x, coords->y);

  gimp_tool_control_set_cursor_modifier (tool->control,
                                         (layer &&
                                          gimp_layer_is_floating_sel (layer)) ?
                                         GIMP_CURSOR_MODIFIER_MOVE            :
                                         GIMP_CURSOR_MODIFIER_NONE);

  GIMP_TOOL_CLASS (parent_class)->cursor_update (tool, coords, state, gdisp);
}

static void
text_tool_render (GimpTextTool *text_tool)
{
  TextOptions *options;
  GimpImage   *gimage;
  GimpText    *text;
  GimpLayer   *layer;
  const gchar *font;
  gchar       *str;
  GtkTextIter  start_iter;
  GtkTextIter  end_iter;

  options = (TextOptions *) GIMP_TOOL (text_tool)->tool_info->tool_options;
  gimage  = text_tool->gdisp->gimage;

  font = gimp_font_selection_get_fontname (GIMP_FONT_SELECTION (options->font_selection));

  if (!font)
    {
      g_message (_("No font chosen or font invalid."));
      return;
    }

  gtk_text_buffer_get_bounds (text_tool->buffer, &start_iter, &end_iter);
  str = gtk_text_buffer_get_text (text_tool->buffer,
                                  &start_iter, &end_iter, FALSE);

  if (!str)
    return;

  text = GIMP_TEXT (g_object_new (GIMP_TYPE_TEXT,
                                  "text",           str,
                                  "font",           font,
                                  "size",           options->size,
                                  "border",         options->border,
                                  "unit",           options->unit,
                                  "letter-spacing", options->letter_spacing,
                                  "line-spacing",   options->line_spacing,
                                  NULL));
  g_free (str);

  layer = gimp_image_text_render (gimage, text);

  g_object_unref (text);

  if (!layer)
    return;

  undo_push_group_start (gimage, TEXT_UNDO_GROUP);

  GIMP_DRAWABLE (layer)->offset_x = text_tool->click_x;
  GIMP_DRAWABLE (layer)->offset_y = text_tool->click_y;

  /*  If there is a selection mask clear it--
   *  this might not always be desired, but in general,
   *  it seems like the correct behavior.
   */
  if (! gimp_image_mask_is_empty (gimage))
    gimp_image_mask_clear (gimage);

  floating_sel_attach (layer, gimp_image_active_drawable (gimage));

  undo_push_group_end (gimage);

  gimp_image_flush (gimage);
}

/*  tool options stuff  */

static GimpToolOptions *
text_tool_options_new (GimpToolInfo *tool_info)
{
  TextOptions  *options;
  PangoContext *pango_context;
  GtkWidget    *vbox;
  GtkWidget    *table;
  GtkWidget    *size_spinbutton;
  GtkWidget    *border_spinbutton;
  GtkWidget    *spin_button;

  options = g_new0 (TextOptions, 1);

  tool_options_init ((GimpToolOptions *) options, tool_info);

  ((GimpToolOptions *) options)->reset_func = text_tool_options_reset;

  options->fontname_d                                 = DEFAULT_FONT;
  options->border         = options->border_d         = 0;
  options->size           = options->size_d           = DEFAULT_FONT_SIZE;
  options->unit           = options->unit_d           = GIMP_UNIT_PIXEL;
  options->line_spacing   = options->line_spacing_d   = 1.0;
  options->letter_spacing = options->letter_spacing_d = 1.0;

  /*  the main vbox  */
  vbox = options->tool_options.main_vbox;

  table = gtk_table_new (4, 5, FALSE);
  gtk_table_set_col_spacings (GTK_TABLE (table), 2);
  gtk_table_set_row_spacings (GTK_TABLE (table), 2);
  gtk_table_set_row_spacing  (GTK_TABLE (table), 3, 12);
  gtk_box_pack_start (GTK_BOX (vbox), GTK_WIDGET (table), FALSE, FALSE, 0);
  gtk_widget_show (table);

  pango_context = pango_ft2_get_context (gimprc.monitor_xres,
                                         gimprc.monitor_yres);

  options->font_selection = gimp_font_selection_new (pango_context);

  g_object_unref (G_OBJECT (pango_context));

  gimp_font_selection_set_fontname 
    (GIMP_FONT_SELECTION (options->font_selection), DEFAULT_FONT);

  gimp_table_attach_aligned (GTK_TABLE (table), 0, 0,
                             _("Font:"), 1.0, 0.5,
                             options->font_selection, 2, FALSE);

  options->size_w = gimp_scale_entry_new (GTK_TABLE (table), 0, 1,
                                          _("_Size:"), -1, 5,
                                          options->size,
                                          1.0, 256.0, 1.0, 50.0, 1,
                                          FALSE, 1e-5, 32767.0,
                                          NULL, NULL);

  size_spinbutton = GIMP_SCALE_ENTRY_SPINBUTTON (options->size_w);

  g_signal_connect (G_OBJECT (options->size_w), "value_changed",
                    G_CALLBACK (gimp_double_adjustment_update),
                    &options->size);

  options->border_w = gimp_scale_entry_new (GTK_TABLE (table), 0, 2,
                                            _("_Border:"), -1, 5,
                                            options->border,
                                            0.0, 100.0, 1.0, 50.0, 1,
                                            FALSE, 0.0, 32767.0,
                                            NULL, NULL);

  border_spinbutton = GIMP_SCALE_ENTRY_SPINBUTTON (options->border_w);

  g_signal_connect (G_OBJECT (options->border_w), "value_changed",
                    G_CALLBACK (gimp_double_adjustment_update),
                    &options->border);

  options->unit_w = gimp_unit_menu_new ("%a", options->unit, 
                                        TRUE, FALSE, TRUE);

  gimp_table_attach_aligned (GTK_TABLE (table), 0, 3,
                             _("Unit:"), 1.0, 0.5,
                             options->unit_w, 2, TRUE);

  g_object_set_data (G_OBJECT (options->unit_w), "set_digits",
                     size_spinbutton);
  g_object_set_data (G_OBJECT (size_spinbutton), "set_digits",
                     border_spinbutton);

  g_signal_connect (G_OBJECT (options->unit_w), "unit_changed",
                    G_CALLBACK (gimp_unit_menu_update),
                    &options->unit);

  spin_button = gimp_spin_button_new (&options->letter_spacing_w,
                                      options->letter_spacing,
                                      0.0, 64.0, 0.1, 1.0, 0.0, 1.0, 2);
  gtk_entry_set_width_chars (GTK_ENTRY (spin_button), 5);
  gimp_table_attach_stock (GTK_TABLE (table), 0, 4,
                           GIMP_STOCK_LETTER_SPACING, spin_button);

  g_signal_connect (G_OBJECT (options->letter_spacing_w), "value_changed",
                    G_CALLBACK (gimp_double_adjustment_update),
                    &options->letter_spacing);

  spin_button = gimp_spin_button_new (&options->line_spacing_w,
                                      options->line_spacing,
                                      0.0, 64.0, 0.1, 1.0, 0.0, 1.0, 2);
  gtk_entry_set_width_chars (GTK_ENTRY (spin_button), 5);
  gimp_table_attach_stock (GTK_TABLE (table), 0, 5,
                           GIMP_STOCK_LINE_SPACING, spin_button);

  g_signal_connect (G_OBJECT (options->line_spacing_w), "value_changed",
                    G_CALLBACK (gimp_double_adjustment_update),
                    &options->line_spacing);

  return (GimpToolOptions *) options;
}

static void
text_tool_options_reset (GimpToolOptions *tool_options)
{
  TextOptions *options;
  GtkWidget   *spinbutton;

  options = (TextOptions *) tool_options;

  gimp_font_selection_set_fontname 
    (GIMP_FONT_SELECTION (options->font_selection), options->fontname_d);
  gtk_adjustment_set_value (GTK_ADJUSTMENT (options->size_w),
			    options->size_d);
  gtk_adjustment_set_value (GTK_ADJUSTMENT (options->border_w),
			    options->border_d);
  
  /* resetting the unit menu is a bit tricky ... */
  options->unit = options->unit_d;
  gimp_unit_menu_set_unit (GIMP_UNIT_MENU (options->unit_w),
                           options->unit_d);
  spinbutton =
    g_object_get_data (G_OBJECT (options->unit_w), "set_digits");
  while (spinbutton)
    {
      gtk_spin_button_set_digits (GTK_SPIN_BUTTON (spinbutton), 0);
      spinbutton =
        g_object_get_data (G_OBJECT (spinbutton), "set_digits");
    }

  gtk_adjustment_set_value (GTK_ADJUSTMENT (options->letter_spacing_w),
                            options->letter_spacing_d);
  gtk_adjustment_set_value (GTK_ADJUSTMENT (options->line_spacing_w),
                            options->line_spacing_d);
}


/* text editor */

static void
text_tool_editor (GimpTextTool *text_tool)
{
  GtkWidget *toolbar;
  GtkWidget *scrolled_window;
  GtkWidget *text_view;

  if (text_tool->editor)
    {
      if (text_tool->editor->window)
        gdk_window_raise (text_tool->editor->window);

      return;
    }

  text_tool->editor = gimp_dialog_new (_("GIMP Text Editor"), "text_editor",
                                       gimp_standard_help_func,
                                       "dialogs/text_editor.html",
                                       GTK_WIN_POS_NONE,
                                       FALSE, TRUE, FALSE,

                                       GTK_STOCK_CANCEL, gtk_widget_destroy,
                                       NULL, 1, NULL, TRUE, TRUE,
                                       
                                       GTK_STOCK_OK, text_tool_editor_ok,
                                       NULL, text_tool, NULL, TRUE, TRUE,

                                       NULL);

  gtk_dialog_set_has_separator (GTK_DIALOG (text_tool->editor), FALSE);

  g_object_add_weak_pointer (G_OBJECT (text_tool->editor),
                             (gpointer) &text_tool->editor);

  toolbar = gtk_toolbar_new ();
  gtk_box_pack_start (GTK_BOX (GTK_DIALOG (text_tool->editor)->vbox),
                      toolbar, FALSE, FALSE, 0);
  gtk_widget_show (toolbar);
 
  gtk_toolbar_insert_stock (GTK_TOOLBAR (toolbar), GTK_STOCK_OPEN,
                            _("Load Text from File"), NULL,
                            G_CALLBACK (text_tool_editor_load), text_tool,
                            0);
  gtk_toolbar_insert_stock (GTK_TOOLBAR (toolbar), GTK_STOCK_CLEAR,
                            _("Clear all Text"), NULL,
                            G_CALLBACK (text_tool_editor_clear), text_tool,
                            1);

  scrolled_window = gtk_scrolled_window_new (NULL, NULL);
  gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scrolled_window),
				  GTK_POLICY_AUTOMATIC,
				  GTK_POLICY_AUTOMATIC);
  gtk_container_set_border_width (GTK_CONTAINER (scrolled_window), 4);
  gtk_box_pack_start (GTK_BOX (GTK_DIALOG (text_tool->editor)->vbox),
                      scrolled_window, TRUE, TRUE, 0);
  gtk_widget_show (scrolled_window);

  text_view = gtk_text_view_new_with_buffer (text_tool->buffer);
  gtk_container_add (GTK_CONTAINER (scrolled_window), text_view);
  gtk_widget_show (text_view);

  gtk_widget_show (text_tool->editor);
}

static void
text_tool_editor_ok (GimpTextTool *text_tool)
{
  gtk_widget_destroy (text_tool->editor);

  text_tool_render (text_tool);
}

static void
text_tool_editor_load (GtkWidget    *widget,
                       GimpTextTool *text_tool)
{
  GtkFileSelection *filesel;

  if (text_tool->filesel)
    {
      if (text_tool->filesel->window)
        gdk_window_raise (text_tool->filesel->window);

      return;
    }

  filesel =
    GTK_FILE_SELECTION (gtk_file_selection_new (_("Open Text File (UTF-8)")));

  gtk_window_set_wmclass (GTK_WINDOW (filesel), "gimp-text-load-file", "Gimp");
  gtk_window_set_position (GTK_WINDOW (filesel), GTK_WIN_POS_MOUSE);

  gtk_container_set_border_width (GTK_CONTAINER (filesel), 2);
  gtk_container_set_border_width (GTK_CONTAINER (filesel->button_area), 2);

  gtk_window_set_transient_for (GTK_WINDOW (filesel),
                                GTK_WINDOW (text_tool->editor));
  gtk_window_set_destroy_with_parent (GTK_WINDOW (filesel), TRUE);

  g_signal_connect_swapped (G_OBJECT (filesel->ok_button), "clicked",
                            G_CALLBACK (text_tool_editor_load_ok),
                            text_tool);
  g_signal_connect_swapped (G_OBJECT (filesel->cancel_button), "clicked",
                            G_CALLBACK (gtk_widget_destroy),
                            filesel);

  gtk_widget_show (GTK_WIDGET (filesel));

  text_tool->filesel = GTK_WIDGET (filesel);
  g_object_add_weak_pointer (G_OBJECT (filesel),
                             (gpointer) &text_tool->filesel);
}

static void
text_tool_editor_load_ok (GimpTextTool *text_tool)
{
  const gchar *filename;

  filename = gtk_file_selection_get_filename (GTK_FILE_SELECTION (text_tool->filesel));
  
  if (text_tool_load_file (text_tool->buffer, filename))
    gtk_widget_destroy (text_tool->filesel);
}

static gboolean
text_tool_load_file (GtkTextBuffer *buffer,
                     const gchar   *filename)
{
  FILE        *file;
  gchar        buf[2048];
  gint         remaining = 0;
  GtkTextIter  iter;

  file = fopen (filename, "r");
  
  if (!file)
    {
      g_message (_("Error opening file '%s': %s"),
                 filename, g_strerror (errno));
      return FALSE;
    }

  gtk_text_buffer_set_text (buffer, "", 0);
  gtk_text_buffer_get_iter_at_offset (buffer, &iter, 0);

  while (!feof (file))
    {
      const char *leftover;
      gint count;
      gint to_read = sizeof (buf) - remaining - 1;

      count = fread (buf + remaining, 1, to_read, file);
      buf[count + remaining] = '\0';

      g_utf8_validate (buf, count + remaining, &leftover);

      gtk_text_buffer_insert (buffer, &iter, buf, leftover - buf);

      remaining = (buf + remaining + count) - leftover;
      g_memmove (buf, leftover, remaining);

      if (remaining > 6 || count < to_read)
        break;
    }

  if (remaining)
    g_message (_("Invalid UTF-8 data in file '%s'."), filename);

  return TRUE;
}

static void
text_tool_editor_clear (GtkWidget    *widget,
                        GimpTextTool *text_tool)
{
  gtk_text_buffer_set_text (text_tool->buffer, "", 0);
}