editgui.c

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 2005 - The Freeciv Project
   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, 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.
***********************************************************************/
 
#ifdef HAVE_CONFIG_H
#include <fc_config.h>
#endif
 
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
 
#include <gtk/gtk.h>
#include <gdk/gdkkeysyms.h>
 
/* utility */
#include "fcintl.h"
#include "log.h"
#include "shared.h"
#include "support.h"
 
/* common */
#include "connection.h"
#include "game.h"
#include "government.h"
#include "packets.h"
 
/* client */
#include "chatline_common.h"
#include "client_main.h"
#include "dialogs_g.h"
#include "editor.h"
#include "mapview_common.h"
#include "tilespec.h"
 
/* client/gui-gtk-4.0 */
#include "canvas.h"
#include "editgui.h"
#include "editprop.h"
#include "gui_main.h"
#include "gui_stuff.h"
#include "plrdlg.h"
#include "sprite.h"
 
 
enum tool_value_selector_columns {
  TVS_COL_IMAGE = 0,
  TVS_COL_ID,
  TVS_COL_NAME,
 
  TVS_NUM_COLS
};
 
enum player_pov_combo_columns {
  PPV_COL_FLAG = 0,
  PPV_COL_NAME,
  PPV_COL_PLAYER_NO,
 
  PPV_NUM_COLS
};
 
enum tool_applied_player_columns {
  TAP_COL_FLAG = 0,
  TAP_COL_NAME,
  TAP_COL_PLAYER_NO,
 
  TAP_NUM_COLS
};
 
enum spin_button_types {
  SPIN_BUTTON_SIZE,
  SPIN_BUTTON_COUNT
};
 
struct tool_value_selector {
  struct editbar *editbar_parent;
 
  GtkWidget *dialog;
 
  GtkListStore *store;
  GtkWidget *view;
};
 
static struct tool_value_selector *
create_tool_value_selector(struct editbar *eb_parent,
                           enum editor_tool_type ett);
static void editinfobox_refresh(struct editinfobox *ei);
static void editbar_player_pov_combobox_changed(GtkComboBox *combo,
                                                gpointer user_data);
static void editbar_mode_button_toggled(GtkToggleButton *tb,
                                        gpointer userdata);
static void editbar_tool_button_toggled(GtkToggleButton *tb,
                                        gpointer userdata);
static void try_to_set_editor_tool(enum editor_tool_type ett);
 
static struct editbar *editor_toolbar;
static struct editinfobox *editor_infobox;
 
/************************************************************************/
static void refresh_all_buttons(struct editbar *eb)
{
  enum editor_tool_type ett;
  enum editor_tool_mode etm;
  GtkWidget *tb = NULL;
  int i;
 
  if (eb == NULL) {
    return;
  }
 
  ett = editor_get_tool();
  etm = editor_tool_get_mode(ett);
 
  for (i = 0; i < NUM_EDITOR_TOOL_MODES; i++) {
    tb = eb->mode_buttons[i];
    if (tb == NULL) {
      continue;
    }
    disable_gobject_callback(G_OBJECT(tb),
                             G_CALLBACK(editbar_mode_button_toggled));
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(tb), i == etm);
    enable_gobject_callback(G_OBJECT(tb),
                            G_CALLBACK(editbar_mode_button_toggled));
    gtk_widget_set_sensitive(tb, editor_tool_has_mode(ett, i));
  }
 
  if (ett < NUM_EDITOR_TOOL_TYPES
      && eb->tool_buttons[ett] != NULL) {
    tb = eb->tool_buttons[ett];
    disable_gobject_callback(G_OBJECT(tb),
                             G_CALLBACK(editbar_tool_button_toggled));
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(tb), TRUE);
    enable_gobject_callback(G_OBJECT(tb),
                            G_CALLBACK(editbar_tool_button_toggled));
  }
}
 
/************************************************************************/
static void editbar_mode_button_toggled(GtkToggleButton *tb,
                                        gpointer userdata)
{
  gboolean active;
  enum editor_tool_mode etm;
  enum editor_tool_type ett;
 
  etm = GPOINTER_TO_INT(userdata);
  if (!(etm < NUM_EDITOR_TOOL_MODES)) {
    return;
  }
 
  active = gtk_toggle_button_get_active(tb);
  ett = editor_get_tool();
 
  editor_tool_set_mode(ett, active ? etm : ETM_PAINT);
  editgui_refresh();
}
 
/************************************************************************/
static void try_to_set_editor_tool(enum editor_tool_type ett)
{
  if (!(ett < NUM_EDITOR_TOOL_TYPES)) {
    return;
  }
 
  if (!editor_tool_is_usable(ett)) {
    GtkWidget *dialog;
 
    dialog = gtk_message_dialog_new(GTK_WINDOW(toplevel),
        GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
        GTK_MESSAGE_ERROR, GTK_BUTTONS_CLOSE, "%s",
        _("The current ruleset does not define any "
          "objects corresponding to this editor tool."));
    gtk_window_set_title(GTK_WINDOW(dialog), editor_tool_get_name(ett));
    blocking_dialog(dialog);
    gtk_window_destroy(GTK_WINDOW(dialog));
  } else {
    editor_set_tool(ett);
  }
}
 
/************************************************************************/
static void editbar_tool_button_toggled(GtkToggleButton *tb,
                                        gpointer userdata)
{
  gboolean active;
  enum editor_tool_type ett;
 
  active = gtk_toggle_button_get_active(tb);
  ett = GPOINTER_TO_INT(userdata);
 
  if (active) {
    try_to_set_editor_tool(ett);
    editgui_refresh();
  }
}
 
/************************************************************************/
static void refresh_player_pov_indicator(struct editbar *eb)
{
  GtkListStore *store;
  GdkPixbuf *flag;
  GtkTreeIter iter;
  GtkWidget *combo;
  int index = -1, i;
 
  if (eb == NULL || eb->player_pov_store == NULL) {
    return;
  }
 
  store = eb->player_pov_store;
  gtk_list_store_clear(store);
 
  gtk_list_store_append(store, &iter);
  gtk_list_store_set(store, &iter, PPV_COL_NAME, _("Global Observer"),
                     PPV_COL_PLAYER_NO, -1, -1);
 
  i = 1;
  players_iterate(pplayer) {
    gtk_list_store_append(store, &iter);
    gtk_list_store_set(store, &iter, PPV_COL_NAME, player_name(pplayer),
                       PPV_COL_PLAYER_NO, player_number(pplayer), -1);
 
    if (pplayer->nation != NO_NATION_SELECTED) {
      flag = get_flag(pplayer->nation);
 
      if (flag != NULL) {
        gtk_list_store_set(store, &iter, PPV_COL_FLAG, flag, -1);
        g_object_unref(flag);
      }
    }
    if (pplayer == client_player()) {
      index = i;
    }
    i++;
  } players_iterate_end;
 
  if (client_is_global_observer()) {
    index = 0;
  }
 
  combo = eb->player_pov_combobox;
  gtk_combo_box_set_active(GTK_COMBO_BOX(combo), index);
}
 
/************************************************************************/
static void editbar_player_pov_combobox_changed(GtkComboBox *combo,
                                                gpointer user_data)
{
  struct editbar *eb = user_data;
  int id;
  struct player *pplayer;
  GtkTreeIter iter;
  GtkTreeModel *model;
 
  if (eb == NULL || eb->widget == NULL
      || !gtk_widget_get_visible(eb->widget)) {
    return;
  }
 
  if (!gtk_combo_box_get_active_iter(combo, &iter)) {
    return;
  }
 
  model = gtk_combo_box_get_model(combo);
  gtk_tree_model_get(model, &iter, PPV_COL_PLAYER_NO, &id, -1);
 
  if ((client_is_global_observer() && id == -1)
      || client_player_number() == id) {
    return;
  }
 
  /* Ugh... hard-coded server command strings. :( */
  if (id == -1) {
    send_chat("/observe");
    return;
  }
 
  pplayer = player_by_number(id);
  if (pplayer != NULL) {
    send_chat_printf("/take \"%s\"", pplayer->name);
  }
}
 
/************************************************************************/
static int tool_value_selector_run(struct tool_value_selector *tvs)
{
  gint res;
  GtkWidget *dialog;
  GtkTreeSelection *sel;
  GtkTreeIter iter;
  GtkTreeModel *model;
  int id;
 
  if (tvs == NULL) {
    return -1;
  }
 
  dialog = tvs->dialog;
  res = blocking_dialog(dialog);
  gtk_widget_hide(dialog);
 
  if (res != GTK_RESPONSE_ACCEPT) {
    return -1;
  }
 
  sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(tvs->view));
  if (!gtk_tree_selection_get_selected(sel, &model, &iter)) {
    return -1;
  }
 
  gtk_tree_model_get(model, &iter, TVS_COL_ID, &id, -1);
 
  return id;
}
 
/************************************************************************/
static bool editgui_run_tool_selection(enum editor_tool_type ett)
{
  struct editbar *eb;
  struct tool_value_selector *tvs;
  int res = -1;
 
  eb = editgui_get_editbar();
  if (eb == NULL || !(ett < NUM_EDITOR_TOOL_TYPES)) {
    return FALSE;
  }
 
  if (!editor_tool_has_value(ett)) {
    return FALSE;
  }
 
  tvs = eb->tool_selectors[ett];
  if (!tvs) {
    return FALSE;
  }
 
  res = tool_value_selector_run(tvs);
 
  if (res >= 0) {
    editor_tool_set_value(ett, res);
    editinfobox_refresh(editgui_get_editinfobox());
  }
 
  return TRUE;
}
 
/************************************************************************/
static gboolean editbar_tool_right_button(GtkGestureClick *gesture,
                                          int n_press,
                                          double x, double y, gpointer data)
{
  return editgui_run_tool_selection(GPOINTER_TO_INT(data));
}
 
/************************************************************************/
static void editbar_add_tool_button(struct editbar *eb,
                                    enum editor_tool_type ett)
{
  GdkPixbuf *pixbuf;
  GtkWidget *pic, *button, *hbox;
  GtkToggleButton *parent = NULL;
  struct sprite *sprite;
  int i;
  GtkGesture *gesture;
  GtkEventController *controller;
 
  if (!eb || !(ett < NUM_EDITOR_TOOL_TYPES)) {
    return;
  }
 
  for (i = 0; i < NUM_EDITOR_TOOL_TYPES; i++) {
    if (eb->tool_buttons[i] != NULL) {
      parent = GTK_TOGGLE_BUTTON(eb->tool_buttons[i]);
      break;
    }
  }
 
  if (parent == NULL) {
    button = gtk_toggle_button_new();
  } else {
    button = gtk_toggle_button_new();
    gtk_toggle_button_set_group(GTK_TOGGLE_BUTTON(button),
                                GTK_TOGGLE_BUTTON(parent));
  }
 
  sprite = editor_tool_get_sprite(ett);
  fc_assert_ret(sprite != NULL);
  pixbuf = sprite_get_pixbuf(sprite);
  pic = gtk_picture_new_for_pixbuf(pixbuf);
  g_object_unref(G_OBJECT(pixbuf));
 
  gtk_button_set_child(GTK_BUTTON(button), pic);
  gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(button), FALSE);
  gtk_widget_set_tooltip_text(button, editor_tool_get_tooltip(ett));
  gtk_size_group_add_widget(eb->size_group, button);
  gtk_button_set_has_frame(GTK_BUTTON(button), FALSE);
  gtk_widget_set_focus_on_click(button, FALSE);
 
  g_signal_connect(button, "toggled",
                   G_CALLBACK(editbar_tool_button_toggled),
                   GINT_TO_POINTER(ett));
 
  gesture = gtk_gesture_click_new();
  gtk_gesture_single_set_button(GTK_GESTURE_SINGLE(gesture), 3);
  controller = GTK_EVENT_CONTROLLER(gesture);
  g_signal_connect(controller, "pressed",
                   G_CALLBACK(editbar_tool_right_button),
                   GINT_TO_POINTER(ett));
  gtk_widget_add_controller(button, controller);
 
  hbox = eb->widget;
  gtk_box_append(GTK_BOX(hbox), button);
  eb->tool_buttons[ett] = button;
 
  if (editor_tool_has_value(ett)) {
    eb->tool_selectors[ett] = create_tool_value_selector(eb, ett);
  }
}
 
/************************************************************************/
static void editbar_player_properties_button_clicked(GtkButton *b,
                                                     gpointer userdata)
{
  struct property_editor *pe;
 
  pe = editprop_get_property_editor();
  property_editor_reload(pe, OBJTYPE_GAME);
  property_editor_reload(pe, OBJTYPE_PLAYER);
  property_editor_popup(pe, OBJTYPE_PLAYER);
}
 
/************************************************************************/
static void editbar_add_mode_button(struct editbar *eb,
                                    enum editor_tool_mode etm)
{
  GdkPixbuf *pixbuf;
  GtkWidget *pic, *button, *hbox;
  struct sprite *sprite;
  const char *tooltip;
 
  if (!eb || !(etm < NUM_EDITOR_TOOL_MODES)) {
    return;
  }
 
  button = gtk_toggle_button_new();
 
  sprite = editor_get_mode_sprite(etm);
  fc_assert_ret(sprite != NULL);
  pixbuf = sprite_get_pixbuf(sprite);
  pic = gtk_picture_new_for_pixbuf(pixbuf);
  g_object_unref(G_OBJECT(pixbuf));
 
  gtk_button_set_child(GTK_BUTTON(button), pic);
  gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(button), FALSE);
  tooltip = editor_get_mode_tooltip(etm);
  if (tooltip != NULL) {
    gtk_widget_set_tooltip_text(button, tooltip);
  }
  gtk_size_group_add_widget(eb->size_group, button);
  gtk_button_set_has_frame(GTK_BUTTON(button), FALSE);
  gtk_widget_set_focus_on_click(button, FALSE);
 
  g_signal_connect(button, "toggled",
                   G_CALLBACK(editbar_mode_button_toggled),
                   GINT_TO_POINTER(etm));
 
  hbox = eb->widget;
  gtk_box_append(GTK_BOX(hbox), button);
  eb->mode_buttons[etm] = button;
}
 
/************************************************************************/
static struct editbar *editbar_create(void)
{
  struct editbar *eb;
  GtkWidget *hbox, *button, *combo, *pic, *separator, *vgrid;
  GtkListStore *store;
  GtkCellRenderer *cell;
  GdkPixbuf *pixbuf;
  const struct editor_sprites *sprites;
  int grid_row = 0;
 
  eb = fc_calloc(1, sizeof(struct editbar));
 
  hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 4);
  eb->widget = hbox;
  eb->size_group = gtk_size_group_new(GTK_SIZE_GROUP_BOTH);
 
  sprites = get_editor_sprites(tileset);
 
  editbar_add_mode_button(eb, ETM_ERASE);
 
  separator = gtk_separator_new(GTK_ORIENTATION_VERTICAL);
  gtk_box_append(GTK_BOX(hbox), separator);
 
  editbar_add_tool_button(eb, ETT_TERRAIN);
  editbar_add_tool_button(eb, ETT_TERRAIN_RESOURCE);
  editbar_add_tool_button(eb, ETT_TERRAIN_SPECIAL);
  editbar_add_tool_button(eb, ETT_ROAD);
  editbar_add_tool_button(eb, ETT_MILITARY_BASE);
  editbar_add_tool_button(eb, ETT_UNIT);
  editbar_add_tool_button(eb, ETT_CITY);
  editbar_add_tool_button(eb, ETT_VISION);
  editbar_add_tool_button(eb, ETT_STARTPOS);
  editbar_add_tool_button(eb, ETT_COPYPASTE);
 
  separator = gtk_separator_new(GTK_ORIENTATION_VERTICAL);
  gtk_box_append(GTK_BOX(hbox), separator);
 
  /* Player POV indicator. */
  vgrid = gtk_grid_new();
  gtk_orientable_set_orientation(GTK_ORIENTABLE(vgrid),
                                 GTK_ORIENTATION_VERTICAL);
  gtk_box_append(GTK_BOX(hbox), vgrid);
 
  store = gtk_list_store_new(PPV_NUM_COLS,
                             GDK_TYPE_PIXBUF,
                             G_TYPE_STRING,
                             G_TYPE_INT);
  eb->player_pov_store = store;
 
  combo = gtk_combo_box_new_with_model(GTK_TREE_MODEL(store));
 
  cell = gtk_cell_renderer_pixbuf_new();
  gtk_cell_layout_pack_start(GTK_CELL_LAYOUT(combo), cell, FALSE);
  gtk_cell_layout_add_attribute(GTK_CELL_LAYOUT(combo),
                                cell, "pixbuf", PPV_COL_FLAG);
 
  cell = gtk_cell_renderer_text_new();
  gtk_cell_layout_pack_start(GTK_CELL_LAYOUT(combo), cell, TRUE);
  gtk_cell_layout_add_attribute(GTK_CELL_LAYOUT(combo),
                                cell, "text", PPV_COL_NAME);
 
  gtk_widget_set_size_request(combo, 140, -1);
  g_signal_connect(combo, "changed",
                   G_CALLBACK(editbar_player_pov_combobox_changed), eb);
 
  gtk_widget_set_tooltip_text(combo,
      _("Switch player point-of-view. Use this to edit "
        "from the perspective of different players, or "
        "even as a global observer."));
  gtk_grid_attach(GTK_GRID(vgrid), combo, 0, grid_row++, 1, 1);
  eb->player_pov_combobox = combo;
 
  /* Property editor button. */
  button = gtk_button_new();
  pixbuf = sprite_get_pixbuf(sprites->properties);
  pic = gtk_picture_new_for_pixbuf(pixbuf);
  g_object_unref(G_OBJECT(pixbuf));
  gtk_button_set_child(GTK_BUTTON(button), pic);
  gtk_widget_set_tooltip_text(button, _("Show the property editor."));
  gtk_size_group_add_widget(eb->size_group, button);
  gtk_button_set_has_frame(GTK_BUTTON(button), FALSE);
  gtk_widget_set_focus_on_click(button, FALSE);
  g_signal_connect(button, "clicked",
                   G_CALLBACK(editbar_player_properties_button_clicked), eb);
  gtk_box_append(GTK_BOX(hbox), button);
 
  return eb;
}
 
/************************************************************************/
static void refresh_tool_value_selector(struct editbar *eb,
                                        enum editor_tool_type ett)
{
  GtkTreeSelection *sel;
  GtkTreeIter iter;
  GtkTreeModel *model;
  int value, store_value;
  struct tool_value_selector *tvs;
 
  if (!editor_is_active() || !eb || !editor_tool_has_value(ett)) {
    return;
  }
 
  tvs = eb->tool_selectors[ett];
 
  if (!tvs) {
    return;
  }
 
  value = editor_tool_get_value(ett);
  model = GTK_TREE_MODEL(tvs->store);
  if (!gtk_tree_model_get_iter_first(model, &iter)) {
    return;
  }
 
  do {
    gtk_tree_model_get(model, &iter, TVS_COL_ID, &store_value, -1);
    if (value == store_value) {
      sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(tvs->view));
      gtk_tree_selection_select_iter(sel, &iter);
      break;
    }
  } while (gtk_tree_model_iter_next(model, &iter));
}
 
/************************************************************************/
static void refresh_all_tool_value_selectors(struct editbar *eb)
{
  int ett;
 
  if (!eb) {
    return;
  }
 
  for (ett = 0; ett < NUM_EDITOR_TOOL_TYPES; ett++) {
    if (editor_tool_has_value(ett)) {
      refresh_tool_value_selector(eb, ett);
    }
  }
}
 
/************************************************************************/
static void editbar_refresh(struct editbar *eb)
{
  if (eb == NULL || eb->widget == NULL) {
    return;
  }
 
  if (!editor_is_active()) {
    gtk_widget_hide(eb->widget);
    return;
  }
 
  refresh_all_buttons(eb);
  refresh_all_tool_value_selectors(eb);
  refresh_player_pov_indicator(eb);
 
  gtk_widget_show(eb->widget);
}
 
/************************************************************************/
static GdkPixbuf *create_terrain_pixbuf(struct terrain *pterrain)
{
  int w, h, i;
  GdkPixbuf *pixbuf;
  struct canvas canvas = FC_STATIC_CANVAS_INIT;
  cairo_t *cr;
 
  w = tileset_tile_width(tileset);
  h = tileset_tile_height(tileset);
 
  canvas.surface = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, w, h);
 
  cr = cairo_create(canvas.surface);
  cairo_set_operator(cr, CAIRO_OPERATOR_CLEAR);
  cairo_paint(cr);
  cairo_destroy(cr);
 
  for (i = 0; i < 3; i++) {
    struct drawn_sprite sprs[80];
    int count = fill_basic_terrain_layer_sprite_array(tileset, sprs,
                                                      i, pterrain);
 
    put_drawn_sprites(&canvas, 1.0, 0, 0, count, sprs, FALSE);
  }
 
  pixbuf = surface_get_pixbuf(canvas.surface, w, h);
  cairo_surface_destroy(canvas.surface);
 
  return pixbuf;
}
 
/************************************************************************/
static void clear_tool_store(GtkListStore *store)
{
  GtkTreeIter iter;
  GtkTreeModel *model = GTK_TREE_MODEL(store);
 
  if (gtk_tree_model_get_iter_first(model, &iter)) {
    do {
      GdkPixbuf *pixbuf;
 
      gtk_tree_model_get(model, &iter, TVS_COL_IMAGE, &pixbuf, -1);
      if (pixbuf != NULL) {
        g_object_unref(pixbuf);
      }
    } while (gtk_tree_model_iter_next(model, &iter));
  }
 
  gtk_list_store_clear(store);
}
 
/************************************************************************/
static void clear_tool_stores(struct editbar *eb)
{
  clear_tool_store(eb->tool_selectors[ETT_TERRAIN]->store);
  clear_tool_store(eb->tool_selectors[ETT_TERRAIN_RESOURCE]->store);
  clear_tool_store(eb->tool_selectors[ETT_TERRAIN_SPECIAL]->store);
  clear_tool_store(eb->tool_selectors[ETT_ROAD]->store);
  clear_tool_store(eb->tool_selectors[ETT_MILITARY_BASE]->store);
  clear_tool_store(eb->tool_selectors[ETT_UNIT]->store);
}
 
/************************************************************************/
static void editbar_reload_tileset(struct editbar *eb)
{
  GtkTreeIter iter;
  GtkListStore *store;
  GdkPixbuf *pixbuf;
  struct sprite *sprite;
  struct tool_value_selector *tvs;
 
  if (eb == NULL || tileset == NULL) {
    return;
  }
 
  clear_tool_stores(eb);
 
  /* Reload terrains. */
 
  tvs = eb->tool_selectors[ETT_TERRAIN];
  store = tvs->store;
 
  terrain_type_iterate(pterrain) {
    gtk_list_store_append(store, &iter);
    gtk_list_store_set(store, &iter,
                       TVS_COL_ID, terrain_number(pterrain),
                       TVS_COL_NAME, terrain_name_translation(pterrain),
                       -1);
    pixbuf = create_terrain_pixbuf(pterrain);
    if (pixbuf != NULL) {
      gtk_list_store_set(store, &iter, TVS_COL_IMAGE, pixbuf, -1);
      g_object_unref(pixbuf);
    }
  } terrain_type_iterate_end;
 
 
  /* Reload terrain resources. */
 
  tvs = eb->tool_selectors[ETT_TERRAIN_RESOURCE];
  store = tvs->store;
 
  extra_type_by_cause_iterate(EC_RESOURCE, pextra) {
    gtk_list_store_append(store, &iter);
    gtk_list_store_set(store, &iter,
                       TVS_COL_ID, extra_index(pextra),
                       TVS_COL_NAME, extra_name_translation(pextra),
                       -1);
    pixbuf = create_extra_pixbuf(pextra);
    if (pixbuf != NULL) {
      gtk_list_store_set(store, &iter, TVS_COL_IMAGE, pixbuf, -1);
      g_object_unref(pixbuf);
    }
  } extra_type_by_cause_iterate_end;
 
  /* Reload terrain specials. */
 
  tvs = eb->tool_selectors[ETT_TERRAIN_SPECIAL];
  store = tvs->store;
 
  extra_type_by_cause_iterate(EC_SPECIAL, pextra) {
    gtk_list_store_append(store, &iter);
    gtk_list_store_set(store, &iter,
                       TVS_COL_ID, extra_index(pextra),
                       TVS_COL_NAME, extra_name_translation(pextra),
                       -1);
    pixbuf = create_extra_pixbuf(pextra);
    if (pixbuf != NULL) {
      gtk_list_store_set(store, &iter, TVS_COL_IMAGE, pixbuf, -1);
      g_object_unref(pixbuf);
    }
  } extra_type_by_cause_iterate_end;
 
  /* Reload roads. */
 
  tvs = eb->tool_selectors[ETT_ROAD];
  store = tvs->store;
 
  extra_type_by_cause_iterate(EC_ROAD, pextra) {
    gtk_list_store_append(store, &iter);
    gtk_list_store_set(store, &iter,
                       TVS_COL_ID, extra_index(pextra),
                       TVS_COL_NAME, extra_name_translation(pextra),
                       -1);
    pixbuf = create_extra_pixbuf(pextra);
    if (pixbuf != NULL) {
      gtk_list_store_set(store, &iter, TVS_COL_IMAGE, pixbuf, -1);
      g_object_unref(pixbuf);
    }
  } extra_type_by_cause_iterate_end;
 
  /* Reload military bases. */
 
  tvs = eb->tool_selectors[ETT_MILITARY_BASE];
  store = tvs->store;
 
  extra_type_by_cause_iterate(EC_BASE, pextra) {
    gtk_list_store_append(store, &iter);
    gtk_list_store_set(store, &iter,
                       TVS_COL_ID, extra_index(pextra),
                       TVS_COL_NAME, extra_name_translation(pextra),
                       -1);
    pixbuf = create_extra_pixbuf(pextra);
    if (pixbuf != NULL) {
      gtk_list_store_set(store, &iter, TVS_COL_IMAGE, pixbuf, -1);
      g_object_unref(pixbuf);
    }
  } extra_type_by_cause_iterate_end;
 
 
  /* Reload unit types. */
 
  tvs = eb->tool_selectors[ETT_UNIT];
  store = tvs->store;
 
  unit_type_iterate(putype) {
    gtk_list_store_append(store, &iter);
    gtk_list_store_set(store, &iter,
                       TVS_COL_ID, utype_number(putype),
                       TVS_COL_NAME, utype_name_translation(putype),
                       -1);
    sprite = get_unittype_sprite(tileset, putype, direction8_invalid());
    if (sprite == NULL) {
      continue;
    }
    pixbuf = sprite_get_pixbuf(sprite);
    if (pixbuf != NULL) {
      gtk_list_store_set(store, &iter, TVS_COL_IMAGE, pixbuf, -1);
      g_object_unref(G_OBJECT(pixbuf));
    }
  } unit_type_iterate_end;
}
 
/************************************************************************/
static int convert_modifiers(int gdk_event_state)
{
  int modifiers = EKM_NONE;
 
  if (gdk_event_state & GDK_SHIFT_MASK) {
    modifiers |= EKM_SHIFT;
  }
  if (gdk_event_state & GDK_CONTROL_MASK) {
    modifiers |= EKM_CTRL;
  }
  if (gdk_event_state & GDK_ALT_MASK) {
    modifiers |= EKM_ALT;
  }
 
  return modifiers;
}
 
/************************************************************************/
gboolean handle_edit_mouse_button_press(GtkGestureClick *gesture,
                                        int editor_mouse_button,
                                        double x, double y)
{
  GdkModifierType state;
 
  state = gtk_event_controller_get_current_event_state(
                            GTK_EVENT_CONTROLLER(gesture));
  editor_mouse_button_press(x, y, editor_mouse_button,
                            convert_modifiers(state));
 
  return TRUE;
}
 
/************************************************************************/
gboolean handle_edit_mouse_button_release(GtkGestureClick *gesture,
                                          int editor_mouse_button,
                                          double x, double y)
{
  GdkModifierType state;
 
  state = gtk_event_controller_get_current_event_state(GTK_EVENT_CONTROLLER(gesture));
  editor_mouse_button_release(x, y,
                              editor_mouse_button,
                              convert_modifiers(state));
  return TRUE;
}
 
/************************************************************************/
gboolean handle_edit_mouse_move(GtkEventControllerMotion *controller,
                                gdouble x, gdouble y)
{
  GdkModifierType state;
 
  state = gtk_event_controller_get_current_event_state(GTK_EVENT_CONTROLLER(controller));
  editor_mouse_move(x, y, convert_modifiers(state));
 
  return TRUE;
}
 
/************************************************************************/
static void tool_value_selector_treeview_row_activated(GtkTreeView *view,
                                                       GtkTreePath *path,
                                                       GtkTreeViewColumn *col,
                                                       gpointer user_data)
{
  struct tool_value_selector *tvs = user_data;
 
  gtk_dialog_response(GTK_DIALOG(tvs->dialog), GTK_RESPONSE_ACCEPT);
}
 
/************************************************************************/
static struct tool_value_selector *
create_tool_value_selector(struct editbar *eb,
                           enum editor_tool_type ett)
{
  struct tool_value_selector *tvs;
  GtkWidget *vbox, *view, *scrollwin;
  GtkCellRenderer *cell;
  GtkListStore *store;
  GtkTreeViewColumn *col;
  GtkTreeSelection *sel;
 
  tvs = fc_calloc(1, sizeof(struct tool_value_selector));
 
  tvs->editbar_parent = eb;
 
  tvs->dialog = gtk_dialog_new_with_buttons(_("Select Tool Value"),
                                            GTK_WINDOW(toplevel), GTK_DIALOG_MODAL,
                                            _("_OK"), GTK_RESPONSE_ACCEPT,
                                            _("_Cancel"), GTK_RESPONSE_REJECT,
                                            NULL);
  vbox = gtk_dialog_get_content_area(GTK_DIALOG(tvs->dialog));
 
  store = gtk_list_store_new(TVS_NUM_COLS,
                             GDK_TYPE_PIXBUF,
                             G_TYPE_INT,
                             G_TYPE_STRING);
  tvs->store = store;
 
  scrollwin = gtk_scrolled_window_new();
  gtk_scrolled_window_set_has_frame(GTK_SCROLLED_WINDOW(scrollwin), TRUE);
  gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrollwin),
                                 GTK_POLICY_NEVER,
                                 GTK_POLICY_AUTOMATIC);
  gtk_scrolled_window_set_min_content_height(GTK_SCROLLED_WINDOW(scrollwin),
                                             10 * tileset_tile_height(tileset));
  gtk_box_insert_child_after(GTK_BOX(vbox), scrollwin, NULL);
 
  view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(tvs->store));
  gtk_widget_set_size_request(view, -1, 10 * tileset_tile_height(tileset));
  gtk_tree_view_set_search_column(GTK_TREE_VIEW(view), TVS_COL_NAME);
  g_signal_connect(view, "row-activated",
                   G_CALLBACK(tool_value_selector_treeview_row_activated), tvs);
 
  sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(view));
  gtk_tree_selection_set_mode(sel, GTK_SELECTION_SINGLE);
 
  cell = gtk_cell_renderer_pixbuf_new();
  col = gtk_tree_view_column_new_with_attributes(editor_tool_get_name(ett),
                                                 cell, "pixbuf",
                                                 TVS_COL_IMAGE, NULL);
  gtk_tree_view_column_set_resizable(col, FALSE);
  gtk_tree_view_column_set_sizing(col, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
  gtk_tree_view_column_set_reorderable(col, FALSE);
  gtk_tree_view_column_set_clickable(col, FALSE);
  gtk_tree_view_append_column(GTK_TREE_VIEW(view), col);
 
  cell = gtk_cell_renderer_text_new();
  col = gtk_tree_view_column_new_with_attributes("ID", cell,
                                                 "text", TVS_COL_ID, NULL);
  gtk_tree_view_column_set_resizable(col, FALSE);
  gtk_tree_view_column_set_sizing(col, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
  gtk_tree_view_column_set_reorderable(col, FALSE);
  gtk_tree_view_column_set_clickable(col, FALSE);
  gtk_tree_view_column_set_sort_column_id(col, TVS_COL_ID);
  gtk_tree_view_append_column(GTK_TREE_VIEW(view), col);
 
  cell = gtk_cell_renderer_text_new();
  col = gtk_tree_view_column_new_with_attributes("Name", cell,
                                                 "text", TVS_COL_NAME, NULL);
  gtk_tree_view_column_set_resizable(col, FALSE);
  gtk_tree_view_column_set_sizing(col, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
  gtk_tree_view_column_set_reorderable(col, FALSE);
  gtk_tree_view_column_set_clickable(col, FALSE);
  gtk_tree_view_column_set_sort_column_id(col, TVS_COL_NAME);
  gtk_tree_view_append_column(GTK_TREE_VIEW(view), col);
 
  gtk_scrolled_window_set_child(GTK_SCROLLED_WINDOW(scrollwin), view);
  tvs->view = view;
 
  /* Show everything but the window itself. */
  gtk_widget_show(vbox);
 
  return tvs;
}
 
/************************************************************************/
static gboolean editinfobox_handle_tool_image_button_press(
                                                    GtkGestureClick *gesture,
                                                    int n_press,
                                                    double x, double y)
{
  editgui_run_tool_selection(editor_get_tool());
 
  return TRUE;
}
 
/************************************************************************/
static gboolean editinfobox_handle_mode_image_button_press(
                                                    GtkGestureClick *gesture,
                                                    int n_press,
                                                    double x, double y)
{
  editor_tool_cycle_mode(editor_get_tool());
  editgui_refresh();
 
  return TRUE;
}
 
/************************************************************************/
static void editinfobox_spin_button_value_changed(GtkSpinButton *spinbutton,
                                                  gpointer userdata)
{
  struct editinfobox *ei;
  int which, value;
  enum editor_tool_type ett;
 
  ei = editgui_get_editinfobox();
 
  if (!ei) {
    return;
  }
 
  value = gtk_spin_button_get_value_as_int(spinbutton);
  which = GPOINTER_TO_INT(userdata);
  ett = editor_get_tool();
 
  switch (which) {
  case SPIN_BUTTON_SIZE:
    editor_tool_set_size(ett, value);
    break;
  case SPIN_BUTTON_COUNT:
    editor_tool_set_count(ett, value);
    break;
  default:
    return;
    break;
  }
 
  editinfobox_refresh(ei);
}
 
/************************************************************************/
static void editinfobox_tool_applied_player_changed(GtkComboBox *combo,
                                                    gpointer userdata)
{
  struct editinfobox *ei = userdata;
  GtkTreeIter iter;
  GtkTreeModel *model;
  int player_no = -1;
 
  if (ei == NULL) {
    return;
  }
 
  if (!gtk_combo_box_get_active_iter(combo, &iter)) {
    return;
  }
 
  model = gtk_combo_box_get_model(combo);
  gtk_tree_model_get(model, &iter, TAP_COL_PLAYER_NO, &player_no, -1);
 
  editor_tool_set_applied_player(editor_get_tool(), player_no);
}
 
/************************************************************************/
static struct editinfobox *editinfobox_create(void)
{
  GtkWidget *label, *vgrid, *frame, *hgrid, *vgrid2, *pic;
  GtkWidget *spin, *combo;
  GtkListStore *store;
  GtkCellRenderer *cell;
  GtkEventController *controller;
  struct editinfobox *ei;
  char buf[128];
  int grid_row = 0;
  int grid_col = 0;
  int grid2_row = 0;
 
  ei = fc_calloc(1, sizeof(*ei));
 
  /* If you turn this to something else than GtkFrame, also adjust
   * editgui.c replace_widget() code that replaces widget in it. */
  frame = gtk_frame_new(_("Editor Tool"));
  gtk_widget_set_margin_start(frame, 4);
  gtk_widget_set_margin_end(frame, 4);
  gtk_widget_set_margin_top(frame, 4);
  gtk_widget_set_margin_bottom(frame, 4);
  ei->widget = frame;
 
  vgrid = gtk_grid_new();
  gtk_orientable_set_orientation(GTK_ORIENTABLE(vgrid),
                                 GTK_ORIENTATION_VERTICAL);
  gtk_grid_set_row_spacing(GTK_GRID(vgrid), 8);
  gtk_widget_set_margin_start(vgrid, 4);
  gtk_widget_set_margin_end(vgrid, 4);
  gtk_widget_set_margin_top(vgrid, 4);
  gtk_widget_set_margin_bottom(vgrid, 4);
  gtk_frame_set_child(GTK_FRAME(frame), vgrid);
 
  /* tool section */
  hgrid = gtk_grid_new();
  gtk_grid_set_column_spacing(GTK_GRID(hgrid), 8);
  gtk_grid_attach(GTK_GRID(vgrid), hgrid, 0, grid_row++, 1, 1);
 
  pic = gtk_picture_new();
  gtk_widget_set_tooltip_text(pic, _("Click to change value if applicable."));
 
  controller = GTK_EVENT_CONTROLLER(gtk_gesture_click_new());
  g_signal_connect(controller, "pressed",
                   G_CALLBACK(editinfobox_handle_tool_image_button_press),
                   NULL);
  gtk_widget_add_controller(pic, controller);
 
  gtk_grid_attach(GTK_GRID(hgrid), pic, grid_col++, 0, 1, 1);
  ei->tool_pic = pic;
 
  vgrid2 = gtk_grid_new();
  gtk_orientable_set_orientation(GTK_ORIENTABLE(vgrid2),
                                 GTK_ORIENTATION_VERTICAL);
  gtk_grid_set_row_spacing(GTK_GRID(vgrid2), 4);
  gtk_grid_attach(GTK_GRID(hgrid), vgrid2, grid_col++, 0, 1, 1);
 
  label = gtk_label_new(NULL);
  gtk_widget_set_halign(label, GTK_ALIGN_START);
  gtk_widget_set_valign(label, GTK_ALIGN_CENTER);
  gtk_grid_attach(GTK_GRID(vgrid2), label, 0, grid2_row++, 1, 1);
  ei->tool_label = label;
 
  label = gtk_label_new(NULL);
  gtk_widget_set_halign(label, GTK_ALIGN_START);
  gtk_widget_set_valign(label, GTK_ALIGN_CENTER);
  gtk_grid_attach(GTK_GRID(vgrid2), label, 0, grid2_row++, 1, 1);
  ei->tool_value_label = label;
 
  /* mode section */
  hgrid = gtk_grid_new();
  grid_col = 0;
  gtk_grid_set_column_spacing(GTK_GRID(hgrid), 8);
  gtk_grid_attach(GTK_GRID(vgrid), hgrid, 0, grid_row++, 1, 1);
 
  pic = gtk_picture_new();
  gtk_widget_set_tooltip_text(pic, _("Click to change tool mode."));
 
  controller = GTK_EVENT_CONTROLLER(gtk_gesture_click_new());
  g_signal_connect(controller, "pressed",
                   G_CALLBACK(editinfobox_handle_mode_image_button_press),
                   NULL);
  gtk_widget_add_controller(pic, controller);
 
  gtk_grid_attach(GTK_GRID(hgrid), pic, grid_col++, 0, 1, 1);
  ei->mode_pic = pic;
 
  vgrid2 = gtk_grid_new();
  grid2_row = 0;
  gtk_orientable_set_orientation(GTK_ORIENTABLE(vgrid2),
                                 GTK_ORIENTATION_VERTICAL);
  gtk_grid_set_row_spacing(GTK_GRID(vgrid2), 4);
  gtk_grid_attach(GTK_GRID(hgrid), vgrid2, grid_col++, 0, 1, 1);
 
  label = gtk_label_new(NULL);
  fc_snprintf(buf, sizeof(buf), "<span weight=\"bold\">%s</span>",
              _("Mode"));
  gtk_label_set_markup(GTK_LABEL(label), buf);
  gtk_widget_set_halign(label, GTK_ALIGN_START);
  gtk_widget_set_valign(label, GTK_ALIGN_CENTER);
  gtk_grid_attach(GTK_GRID(vgrid2), label, 0, grid2_row++, 1, 1);
 
  label = gtk_label_new(NULL);
  gtk_widget_set_halign(label, GTK_ALIGN_START);
  gtk_widget_set_valign(label, GTK_ALIGN_CENTER);
  gtk_grid_attach(GTK_GRID(vgrid2), label, 0, grid2_row++, 1, 1);
  ei->mode_label = label;
 
  /* spinner section */
  hgrid = gtk_grid_new();
  grid_col = 0;
  gtk_grid_set_column_spacing(GTK_GRID(hgrid), 8);
  gtk_grid_attach(GTK_GRID(vgrid), hgrid, 0, grid_row++, 1, 1);
  ei->size_hbox = hgrid;
  spin = gtk_spin_button_new_with_range(1, 255, 1);
  gtk_widget_set_tooltip_text(spin,
      _("Use this to change the \"size\" parameter for the tool. "
        "This parameter controls for example the half-width "
        "of the square of tiles that will be affected by the "
        "tool, or the size of a created city."));
  g_signal_connect(spin, "value-changed",
                   G_CALLBACK(editinfobox_spin_button_value_changed),
                   GINT_TO_POINTER(SPIN_BUTTON_SIZE));
  gtk_grid_attach(GTK_GRID(hgrid), spin, grid_col++, 0, 1, 1);
  ei->size_spin_button = spin;
  label = gtk_label_new(_("Size"));
  gtk_grid_attach(GTK_GRID(hgrid), label, grid_col++, 0, 1, 1);
 
  hgrid = gtk_grid_new();
  grid_col = 0;
  gtk_grid_set_column_spacing(GTK_GRID(hgrid), 8);
  gtk_grid_attach(GTK_GRID(vgrid), hgrid, 0, grid_row++, 1, 1);
  ei->count_hbox = hgrid;
  spin = gtk_spin_button_new_with_range(1, 255, 1);
  gtk_widget_set_tooltip_text(spin,
      _("Use this to change the tool's \"count\" parameter. "
        "This controls for example how many units are placed "
        "at once with the unit tool."));
  g_signal_connect(spin, "value-changed",
                   G_CALLBACK(editinfobox_spin_button_value_changed),
                   GINT_TO_POINTER(SPIN_BUTTON_COUNT));
  gtk_grid_attach(GTK_GRID(hgrid), spin, grid_col++, 0, 1, 1);
  ei->count_spin_button = spin;
  label = gtk_label_new(_("Count"));
  gtk_grid_attach(GTK_GRID(hgrid), label, grid_col++, 0, 1, 1);
 
  /* combo section */
  store = gtk_list_store_new(TAP_NUM_COLS,
                             GDK_TYPE_PIXBUF,
                             G_TYPE_STRING,
                             G_TYPE_INT);
  ei->tool_applied_player_store = store;
  combo = gtk_combo_box_new_with_model(GTK_TREE_MODEL(store));
 
  cell = gtk_cell_renderer_pixbuf_new();
  gtk_cell_layout_pack_start(GTK_CELL_LAYOUT(combo), cell, FALSE);
  gtk_cell_layout_add_attribute(GTK_CELL_LAYOUT(combo),
                                cell, "pixbuf", TAP_COL_FLAG);
 
  cell = gtk_cell_renderer_text_new();
  gtk_cell_layout_pack_start(GTK_CELL_LAYOUT(combo), cell, TRUE);
  gtk_cell_layout_add_attribute(GTK_CELL_LAYOUT(combo),
                                cell, "text", TAP_COL_NAME);
 
  gtk_widget_set_size_request(combo, 132, -1);
  g_signal_connect(combo, "changed",
                   G_CALLBACK(editinfobox_tool_applied_player_changed), ei);
 
  gtk_widget_set_tooltip_text(combo,
      _("Use this to change the \"applied player\" tool parameter. "
        "This controls for example under which player units and cities "
        "are created."));
  gtk_grid_attach(GTK_GRID(vgrid), combo, 0, grid_row++, 1, 1);
  ei->tool_applied_player_combobox = combo;
 
  /* We add a ref to the editinfobox widget so that it is
   * not destroyed when replaced by the unit info box when
   * we leave edit mode. See editinfobox_refresh() call to replace_widget() */
  g_object_ref(ei->widget);
 
  /* The edit info box starts with no parent, so we have to
   * show its internal widgets manually. */
  gtk_widget_show(ei->widget);
 
  return ei;
}
 
/************************************************************************/
static void refresh_tool_applied_player_combo(struct editinfobox *ei)
{
  enum editor_tool_type ett;
  GtkListStore *store;
  GtkWidget *combo;
  GtkTreeIter iter;
  GdkPixbuf *flag;
  int apno, index, i;
 
  if (!ei) {
    return;
  }
 
  ett = editor_get_tool();
  combo = ei->tool_applied_player_combobox;
  store = ei->tool_applied_player_store;
 
  if (!combo || !store) {
    return;
  }
 
  if (!editor_tool_has_applied_player(ett)) {
    gtk_widget_hide(combo);
    return;
  }
 
  gtk_list_store_clear(store);
 
  apno = editor_tool_get_applied_player(ett);
  index = -1;
  i = 0;
 
  players_iterate(pplayer) {
    gtk_list_store_append(store, &iter);
    gtk_list_store_set(store, &iter,
                       TAP_COL_PLAYER_NO, player_number(pplayer),
                       TAP_COL_NAME, player_name(pplayer), -1);
 
    if (pplayer->nation != NO_NATION_SELECTED) {
      flag = get_flag(pplayer->nation);
 
      if (flag != NULL) {
        gtk_list_store_set(store, &iter, TAP_COL_FLAG, flag, -1);
        g_object_unref(flag);
      }
    }
    if (apno == player_number(pplayer)) {
      index = i;
    }
    i++;
  } players_iterate_end;
 
  if (index == -1) {
    if (player_count() > 0) {
      index = 0;
    }
    editor_tool_set_applied_player(ett, index);
  }
  gtk_combo_box_set_active(GTK_COMBO_BOX(combo), index);
  gtk_widget_show(combo);
}
 
/************************************************************************/
static GdkPixbuf *get_tool_value_pixbuf(enum editor_tool_type ett,
                                        int value)
{
  struct sprite *sprite = NULL;
  GdkPixbuf *pixbuf = NULL;
  struct terrain *pterrain;
  struct unit_type *putype;
  const struct editor_sprites *sprites;
 
  sprites = get_editor_sprites(tileset);
  if (!sprites) {
    return NULL;
  }
 
  switch (ett) {
  case ETT_TERRAIN:
    pterrain = terrain_by_number(value);
    if (pterrain) {
      pixbuf = create_terrain_pixbuf(pterrain);
    }
    break;
  case ETT_TERRAIN_RESOURCE:
  case ETT_TERRAIN_SPECIAL:
  case ETT_ROAD:
  case ETT_MILITARY_BASE:
    if (value >= 0) {
      pixbuf = create_extra_pixbuf(extra_by_number(value));
    }
    break;
  case ETT_UNIT:
    putype = utype_by_number(value);
    if (putype) {
      sprite = get_unittype_sprite(tileset, putype, direction8_invalid());
    }
    break;
  case ETT_CITY:
    sprite = sprites->city;
    break;
  case ETT_VISION:
    sprite = sprites->vision;
    break;
  case ETT_STARTPOS:
    sprite = sprites->startpos;
    break;
  case ETT_COPYPASTE:
    sprite = sprites->copypaste;
    break;
  default:
    break;
  }
 
  if (sprite) {
    pixbuf = sprite_get_pixbuf(sprite);
    /*
    if (pixbuf) {
      g_object_ref(pixbuf);
    }
    */
    sprite = NULL;
  }
 
  return pixbuf;
}
 
/************************************************************************/
static GdkPixbuf *get_tool_mode_pixbuf(enum editor_tool_mode etm)
{
  struct sprite *sprite = NULL;
  GdkPixbuf *pixbuf = NULL;
 
  sprite = editor_get_mode_sprite(etm);
 
  if (sprite) {
    pixbuf = sprite_get_pixbuf(sprite);
    /*
    if (pixbuf) {
      g_object_ref(pixbuf);
    }
    */
  }
 
  return pixbuf;
}
 
/************************************************************************/
static void replace_widget(GtkWidget *old, GtkWidget *new)
{
  GtkWidget *parent;
 
  parent = gtk_widget_get_parent(old);
  if (!parent) {
    return;
  }
 
  gtk_widget_hide(old);
 
  if (GTK_IS_FRAME(parent)) {
    gtk_frame_set_child(GTK_FRAME(parent), new);
  } else {
    fc_assert(GTK_IS_BOX(parent));
 
    gtk_box_remove(GTK_BOX(parent), old);
    gtk_box_append(GTK_BOX(parent), new);
  }
 
  gtk_widget_show(new);
}
 
/************************************************************************/
static void editinfobox_refresh(struct editinfobox *ei)
{
  GdkPixbuf *pixbuf = NULL;
  GtkLabel *label;
  enum editor_tool_type ett;
  enum editor_tool_mode etm;
  int value;
  char buf[256];
 
  if (ei == NULL) {
    return;
  }
 
  if (!editor_is_active()) {
    replace_widget(ei->widget, unit_info_box);
    return;
  }
 
  ett = editor_get_tool();
  etm = editor_tool_get_mode(ett);
  value = editor_tool_get_value(ett);
 
  label = GTK_LABEL(ei->mode_label);
  gtk_label_set_text(label, editor_tool_get_mode_name(ett, etm));
 
  pixbuf = get_tool_mode_pixbuf(etm);
  gtk_picture_set_pixbuf(GTK_PICTURE(ei->mode_pic), pixbuf);
  if (pixbuf) {
    g_object_unref(pixbuf);
    pixbuf = NULL;
  }
 
  fc_snprintf(buf, sizeof(buf), "<span weight=\"bold\">%s</span>",
              editor_tool_get_name(ett));
  gtk_label_set_markup(GTK_LABEL(ei->tool_label), buf);
 
  if (etm == ETM_COPY || etm == ETM_PASTE) {
    struct edit_buffer *ebuf;
    struct sprite *spr;
    char status[256];
 
    ebuf = editor_get_copy_buffer();
    edit_buffer_get_status_string(ebuf, status, sizeof(status));
    gtk_label_set_text(GTK_LABEL(ei->tool_value_label), status);
 
    spr = editor_tool_get_sprite(ett);
    pixbuf = spr ? sprite_get_pixbuf(spr) : NULL;
    gtk_picture_set_pixbuf(GTK_PICTURE(ei->tool_pic), pixbuf);
    if (pixbuf) {
      g_object_unref(G_OBJECT(pixbuf));
      pixbuf = NULL;
    }
  } else {
    pixbuf = get_tool_value_pixbuf(ett, value);
    gtk_picture_set_pixbuf(GTK_PICTURE(ei->tool_pic), pixbuf);
    if (pixbuf) {
      g_object_unref(pixbuf);
      pixbuf = NULL;
    }
    gtk_label_set_text(GTK_LABEL(ei->tool_value_label),
                       editor_tool_get_value_name(ett, value));
  }
 
  replace_widget(unit_info_box, ei->widget);
 
  if (editor_tool_has_size(ett)) {
    gtk_spin_button_set_value(GTK_SPIN_BUTTON(ei->size_spin_button),
                              editor_tool_get_size(ett));
    gtk_widget_show(ei->size_hbox);
  } else {
    gtk_widget_hide(ei->size_hbox);
  }
 
  if (editor_tool_has_count(ett)) {
    gtk_spin_button_set_value(GTK_SPIN_BUTTON(ei->count_spin_button),
                              editor_tool_get_count(ett));
    gtk_widget_show(ei->count_hbox);
  } else {
    gtk_widget_hide(ei->count_hbox);
  }
 
  refresh_tool_applied_player_combo(ei);
}
 
/************************************************************************/
static gboolean handle_edit_key_press_with_ctrl(guint keyval)
{
  return FALSE; /* Don't gobble. */
}
 
/************************************************************************/
static gboolean handle_edit_key_press_with_shift(guint keyval)
{
  enum editor_tool_type ett;
 
  ett = editor_get_tool();
  switch (keyval) {
  case GDK_KEY_D:
    editor_tool_toggle_mode(ett, ETM_ERASE);
    break;
  case GDK_KEY_C:
    editor_set_tool(ETT_COPYPASTE);
    editor_tool_toggle_mode(ett, ETM_COPY);
    break;
  case GDK_KEY_V:
    editor_set_tool(ETT_COPYPASTE);
    editor_tool_toggle_mode(ett, ETM_PASTE);
    break;
  case GDK_KEY_T:
    editgui_run_tool_selection(ETT_TERRAIN);
    break;
  case GDK_KEY_R:
    editgui_run_tool_selection(ETT_TERRAIN_RESOURCE);
    break;
  case GDK_KEY_S:
    editgui_run_tool_selection(ETT_TERRAIN_SPECIAL);
    break;
  case GDK_KEY_P:
    editgui_run_tool_selection(ETT_ROAD);
    break;
  case GDK_KEY_M:
    editgui_run_tool_selection(ETT_MILITARY_BASE);
    break;
  case GDK_KEY_U:
    editgui_run_tool_selection(ETT_UNIT);
    break;
  default:
    return TRUE; /* Gobble? */
    break;
  }
 
  editgui_refresh();
 
  return TRUE;
}
 
/************************************************************************/
gboolean handle_edit_key_press(guint keyval, GdkModifierType state)
{
  enum editor_tool_type ett, new_ett = NUM_EDITOR_TOOL_TYPES;
 
  /* Check ctrl before shift - this is correct also for the case where
   * they are both active. */
  if (state & GDK_CONTROL_MASK) {
    return handle_edit_key_press_with_ctrl(keyval);
  }
 
  if (state & GDK_SHIFT_MASK) {
    return handle_edit_key_press_with_shift(keyval);
  }
 
  ett = editor_get_tool();
 
  switch (keyval) {
  case GDK_KEY_t:
    new_ett = ETT_TERRAIN;
    break;
  case GDK_KEY_r:
    new_ett = ETT_TERRAIN_RESOURCE;
    break;
  case GDK_KEY_s:
    new_ett = ETT_TERRAIN_SPECIAL;
    break;
  case GDK_KEY_p:
    new_ett = ETT_ROAD;
    break;
  case GDK_KEY_m:
    new_ett = ETT_MILITARY_BASE;
    break;
  case GDK_KEY_u:
    new_ett = ETT_UNIT;
    break;
  case GDK_KEY_c:
    new_ett = ETT_CITY;
    break;
  case GDK_KEY_v:
    new_ett = ETT_VISION;
    break;
  case GDK_KEY_b:
    new_ett = ETT_STARTPOS;
    break;
  case GDK_KEY_plus:
  case GDK_KEY_equal:
  case GDK_KEY_KP_Add:
    if (editor_tool_has_size(ett)) {
      int size = editor_tool_get_size(ett);
 
      editor_tool_set_size(ett, size + 1);
    } else if (editor_tool_has_count(ett)) {
      int count = editor_tool_get_count(ett);
 
      editor_tool_set_count(ett, count + 1);
    }
    break;
  case GDK_KEY_minus:
  case GDK_KEY_underscore:
  case GDK_KEY_KP_Subtract:
    if (editor_tool_has_size(ett)) {
      int size = editor_tool_get_size(ett);
 
      editor_tool_set_size(ett, size - 1);
    } else if (editor_tool_has_count(ett)) {
      int count = editor_tool_get_count(ett);
 
      editor_tool_set_count(ett, count - 1);
    }
    break;
  case GDK_KEY_1:
  case GDK_KEY_2:
  case GDK_KEY_3:
  case GDK_KEY_4:
  case GDK_KEY_5:
  case GDK_KEY_6:
  case GDK_KEY_7:
  case GDK_KEY_8:
  case GDK_KEY_9:
    if (editor_tool_has_size(ett)) {
      editor_tool_set_size(ett, keyval - GDK_KEY_1 + 1);
    } else if (editor_tool_has_count(ett)) {
      editor_tool_set_count(ett, keyval - GDK_KEY_1 + 1);
    }
    break;
  case GDK_KEY_space:
    editor_apply_tool_to_selection();
    break;
  case GDK_KEY_Tab:
    editgui_run_tool_selection(ett);
    break;
  case GDK_KEY_F1:
  case GDK_KEY_F2:
  case GDK_KEY_F3:
  case GDK_KEY_F4:
  case GDK_KEY_F5:
  case GDK_KEY_F6:
  case GDK_KEY_F7:
  case GDK_KEY_F8:
  case GDK_KEY_F9:
  case GDK_KEY_F10:
  case GDK_KEY_F11:
  case GDK_KEY_F12:
    return FALSE; /* Allow default handler. */
    break;
  default:
    return TRUE; /* Gobbled... */
    break;
  }
 
  if (new_ett != NUM_EDITOR_TOOL_TYPES) {
    try_to_set_editor_tool(new_ett);
  }
 
  editgui_refresh();
 
  return TRUE;
}
 
/************************************************************************/
struct editbar *editgui_get_editbar(void)
{
  return editor_toolbar;
}
 
/************************************************************************/
void editgui_refresh(void)
{
  struct property_editor *pe;
  struct editbar *eb;
  struct editinfobox *ei;
 
  eb = editgui_get_editbar();
  if (eb != NULL) {
    editbar_refresh(eb);
  }
 
  ei = editgui_get_editinfobox();
  if (ei != NULL) {
    editinfobox_refresh(ei);
  }
 
  pe = editprop_get_property_editor();
  if (!editor_is_active()) {
    property_editor_clear(pe);
    property_editor_popdown(pe);
  }
}
 
/************************************************************************/
void editgui_create_widgets(void)
{
  if (editor_toolbar == NULL) {
    editor_toolbar = editbar_create();
  }
  if (editor_infobox == NULL) {
    editor_infobox = editinfobox_create();
  }
}
 
/************************************************************************/
void editgui_free(void)
{
  struct editbar *eb = editgui_get_editbar();
  struct editinfobox *ei = editgui_get_editinfobox();
 
  if (ei != NULL) {
    /* We have extra ref for ei->widget that has protected
     * it from getting destroyed when editinfobox_refresh()
     * moves widgets around. Free that extra ref here. */
    g_object_unref(ei->widget);
  }
 
  clear_tool_stores(eb);
}
 
/************************************************************************/
struct editinfobox *editgui_get_editinfobox(void)
{
  return editor_infobox;
}
 
/************************************************************************/
void editgui_tileset_changed(void)
{
  editbar_reload_tileset(editgui_get_editbar());
  editinfobox_refresh(editgui_get_editinfobox());
}
 
/************************************************************************/
void editgui_popup_properties(const struct tile_list *tiles, int objtype)
{
  struct property_editor *pe;
 
  pe = editprop_get_property_editor();
  property_editor_clear(pe);
  property_editor_reload(pe, OBJTYPE_PLAYER);
  property_editor_reload(pe, OBJTYPE_GAME);
  property_editor_load_tiles(pe, tiles);
  property_editor_popup(pe, objtype);
}
 
/************************************************************************/
void editgui_popdown_all(void)
{
  struct property_editor *pe;
 
  pe = editprop_get_property_editor();
  property_editor_popdown(pe);
  property_editor_clear(pe);    /* And clear it. */
}
 
/************************************************************************/
void editgui_notify_object_changed(int objtype, int object_id, bool removal)
{
  struct property_editor *pe;
 
  if (!editor_is_active()) {
    return;
  }
 
  pe = editprop_get_property_editor();
  property_editor_handle_object_changed(pe, objtype, object_id, removal);
}
 
/************************************************************************/
void editgui_notify_object_created(int tag, int id)
{
  struct property_editor *pe;
 
  if (!editor_is_active()) {
    return;
  }
 
  pe = editprop_get_property_editor();
  property_editor_handle_object_created(pe, tag, id);
}