chatline.c

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   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 <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
 
#include <gdk/gdkkeysyms.h>
 
/* utility */
#include "fcintl.h"
#include "genlist.h"
#include "log.h"
#include "mem.h"
#include "support.h"
 
/* common */
#include "chat.h"
#include "featured_text.h"
#include "game.h"
#include "packets.h"
 
/* client */
#include "client_main.h"
#include "climap.h"
#include "control.h"
#include "mapview_common.h"
 
/* client/gui-gtk-4.0 */
#include "colors.h"
#include "gui_main.h"
#include "gui_stuff.h"
#include "menu.h"
#include "pages.h"
 
#include "chatline.h"
 
#define MAX_CHATLINE_HISTORY 20
 
static struct genlist *history_list = NULL;
static int history_pos = -1;
 
static struct inputline_toolkit {
  GtkWidget *main_widget;
  GtkWidget *entry;
  GtkWidget *button_box;
  GtkWidget *toolbar;
  GtkWidget *toggle_button;
  bool toolbar_displayed;
} toolkit;      /* Singleton. */
 
static void inputline_make_tag(GtkEntry *entry, enum text_tag_type type);
 
/**********************************************************************/
bool inputline_has_focus(void)
{
  return gtk_widget_has_focus(toolkit.entry);
}
 
/**********************************************************************/
void inputline_grab_focus(void)
{
  gtk_widget_grab_focus(toolkit.entry);
}
 
/**********************************************************************/
bool inputline_is_visible(void)
{
  return gtk_widget_get_mapped(toolkit.entry);
}
 
/**********************************************************************/
static gboolean il_lost_focus(GtkEventControllerFocus *controller,
                              gpointer data)
{
  real_menus_update();
 
  return TRUE;
}
 
/**********************************************************************/
static gboolean il_gained_focus(GtkEventControllerFocus *controller,
                                gpointer data)
{
  menus_disable_unit_commands();
 
  return TRUE;
}
 
/**********************************************************************/
static bool is_plain_public_message(const char *s)
{
  const char *p;
 
  /* If it is a server command or an explicit ally
   * message, then it is not a public message. */
  if (s[0] == SERVER_COMMAND_PREFIX || s[0] == CHAT_ALLIES_PREFIX) {
    return FALSE;
  }
 
  /* It might be a private message of the form
   *   'player name with spaces':the message
   * or with ". So skip past the player name part. */
  if (s[0] == '\'' || s[0] == '"') {
    p = strchr(s + 1, s[0]);
  } else {
    p = s;
  }
 
  /* Now we just need to check that it is not a private
   * message. If we encounter a space then the preceding
   * text could not have been a user/player name (the
   * quote check above eliminated names with spaces) so
   * it must be a public message. Otherwise if we encounter
   * the message prefix : then the text parsed up until now
   * was a player/user name and the line is intended as
   * a private message (or explicit public message if the
   * first character is :). */
  while (p != NULL && *p != '\0') {
    if (fc_isspace(*p)) {
      return TRUE;
    } else if (*p == CHAT_DIRECT_PREFIX) {
      return FALSE;
    }
    p++;
  }
  return TRUE;
}
 
 
/**********************************************************************/
static void inputline_return(GtkEntry *w, gpointer data)
{
  const char *theinput;
  GtkEntryBuffer *buffer = gtk_entry_get_buffer(w);
 
  theinput = gtk_entry_buffer_get_text(buffer);
 
  if (*theinput) {
    if (client_state() == C_S_RUNNING
        && GUI_GTK_OPTION(allied_chat_only)
        && is_plain_public_message(theinput)) {
      char buf[MAX_LEN_MSG];
 
      fc_snprintf(buf, sizeof(buf), ". %s", theinput);
      send_chat(buf);
    } else {
      send_chat(theinput);
    }
 
    if (genlist_size(history_list) >= MAX_CHATLINE_HISTORY) {
      void *history_data;
 
      history_data = genlist_get(history_list, -1);
      genlist_remove(history_list, history_data);
      free(history_data);
    }
 
    genlist_prepend(history_list, fc_strdup(theinput));
    history_pos = -1;
  }
 
  gtk_entry_buffer_set_text(buffer, "", -1);
}
 
/**********************************************************************/
static const char *get_player_or_user_name(int id)
{
  size_t size = conn_list_size(game.all_connections);
 
  if (id < size) {
    return conn_list_get(game.all_connections, id)->username;
  } else {
    struct player *pplayer = player_by_number(id - size);
    if (pplayer) {
      return pplayer->name;
    } else {
      /* Empty slot. Relies on being used with comparison function
       * which can cope with NULL. */
      return NULL;
    }
  }
}
 
/**********************************************************************/
static int check_player_or_user_name(const char *prefix,
                                     const char **matches,
                                     const int max_matches)
{
  int matches_id[max_matches * 2], ind, num;
 
  switch (match_prefix_full(get_player_or_user_name,
                            player_slot_count()
                            + conn_list_size(game.all_connections),
                            MAX_LEN_NAME, fc_strncasecmp, strlen,
                            prefix, &ind, matches_id,
                            max_matches * 2, &num)) {
  case M_PRE_EXACT:
  case M_PRE_ONLY:
    matches[0] = get_player_or_user_name(ind);
    return 1;
  case M_PRE_AMBIGUOUS:
    {
      /* Remove duplications playername/username. */
      const char *name;
      int i, j, c = 0;
 
      for (i = 0; i < num && c < max_matches; i++) {
        name = get_player_or_user_name(matches_id[i]);
        for (j = 0; j < c; j++) {
          if (0 == fc_strncasecmp(name, matches[j], MAX_LEN_NAME)) {
            break;
          }
        }
        if (j >= c) {
          matches[c++] = name;
        }
      }
      return c;
    }
  case M_PRE_EMPTY:
  case M_PRE_LONG:
  case M_PRE_FAIL:
  case M_PRE_LAST:
    break;
  }
 
  return 0;
}
 
/**********************************************************************/
static size_t get_common_prefix(const char *const *prefixes,
                                size_t num_prefixes,
                                char *buf, size_t buf_len)
{
  const char *p;
  char *q;
  size_t i;
 
  fc_strlcpy(buf, prefixes[0], buf_len);
  for (i = 1; i < num_prefixes; i++) {
    for (p = prefixes[i], q = buf; *p != '\0' && *q != '\0';
         p = g_utf8_next_char(p), q = g_utf8_next_char(q)) {
      if (g_unichar_toupper(g_utf8_get_char(p))
          != g_unichar_toupper(g_utf8_get_char(q))) {
        *q = '\0';
        break;
      }
    }
  }
 
 return g_utf8_strlen(buf, -1);
}
 
/**********************************************************************/
static bool chatline_autocomplete(GtkEditable *editable)
{
#define MAX_MATCHES 10
  const char *name[MAX_MATCHES];
  char buf[MAX_LEN_NAME * MAX_MATCHES];
  gint pos;
  gchar *chars, *p, *prev;
  int num, i;
  size_t prefix_len;
 
  /* Part 1: get the string to complete. */
  pos = gtk_editable_get_position(editable);
  chars = gtk_editable_get_chars(editable, 0, pos);
 
  p = chars + strlen(chars);
  while ((prev = g_utf8_find_prev_char(chars, p))) {
    if (!g_unichar_isalnum(g_utf8_get_char(prev))) {
      break;
    }
    p = prev;
  }
  /* p points to the start of the last word, or the start of the string. */
 
  prefix_len = g_utf8_strlen(p, -1);
  if (0 == prefix_len) {
    /* Empty: nothing to complete, propagate the event. */
    g_free(chars);
    return FALSE;
  }
 
  /* Part 2: compare with player and user names. */
  num = check_player_or_user_name(p, name, MAX_MATCHES);
  if (1 == num) {
    gtk_editable_delete_text(editable, pos - prefix_len, pos);
    pos -= prefix_len;
    gtk_editable_insert_text(editable, name[0], strlen(name[0]), &pos);
    gtk_editable_set_position(editable, pos);
    g_free(chars);
    return TRUE;
  } else if (num > 1) {
    if (get_common_prefix(name, num, buf, sizeof(buf)) > prefix_len) {
      gtk_editable_delete_text(editable, pos - prefix_len, pos);
      pos -= prefix_len;
      gtk_editable_insert_text(editable, buf, strlen(buf), &pos);
      gtk_editable_set_position(editable, pos);
    }
    sz_strlcpy(buf, name[0]);
    for (i = 1; i < num; i++) {
      cat_snprintf(buf, sizeof(buf), ", %s", name[i]);
    }
    /* TRANS: comma-separated list of player/user names for completion */
    output_window_printf(ftc_client, _("Suggestions: %s."), buf);
  }
 
  g_free(chars);
  return TRUE;
}
 
/**********************************************************************/
static gboolean inputline_handler(GtkEventControllerKey *controller,
                                  guint keyval,
                                  guint keycode,
                                  GdkModifierType state,
                                  gpointer data)
{
  GtkWidget *w = gtk_event_controller_get_widget(GTK_EVENT_CONTROLLER(controller));
 
  if ((state & GDK_CONTROL_MASK)) {
    /* Chatline featured text support. */
 
    switch (keyval) {
    case GDK_KEY_b:
      inputline_make_tag(GTK_ENTRY(w), TTT_BOLD);
      return TRUE;
 
    case GDK_KEY_c:
      inputline_make_tag(GTK_ENTRY(w), TTT_COLOR);
      return TRUE;
 
    case GDK_KEY_i:
      inputline_make_tag(GTK_ENTRY(w), TTT_ITALIC);
      return TRUE;
 
    case GDK_KEY_s:
      inputline_make_tag(GTK_ENTRY(w), TTT_STRIKE);
      return TRUE;
 
    case GDK_KEY_u:
      inputline_make_tag(GTK_ENTRY(w), TTT_UNDERLINE);
      return TRUE;
 
    default:
      break;
    }
 
  } else {
    /* Chatline history controls. */
    GtkEntryBuffer *buffer = gtk_entry_get_buffer(GTK_ENTRY(w));
 
    switch (keyval) {
    case GDK_KEY_Up:
      if (history_pos < genlist_size(history_list) - 1) {
        gtk_entry_buffer_set_text(buffer,
                                  genlist_get(history_list, ++history_pos),
                                  -1);
        gtk_editable_set_position(GTK_EDITABLE(w), -1);
      }
      return TRUE;
 
    case GDK_KEY_Down:
      if (history_pos >= 0) {
        history_pos--;
      }
 
      if (history_pos >= 0) {
        gtk_entry_buffer_set_text(buffer,
                                  genlist_get(history_list, history_pos),
                                  -1);
      } else {
        gtk_entry_buffer_set_text(buffer, "", -1);
      }
      gtk_editable_set_position(GTK_EDITABLE(w), -1);
      return TRUE;
 
    case GDK_KEY_Tab:
      if (GUI_GTK_OPTION(chatline_autocompletion)) {
        return chatline_autocomplete(GTK_EDITABLE(w));
      }
      return FALSE;
 
    default:
      break;
    }
  }
 
  return FALSE;
}
 
/**********************************************************************/
void inputline_make_tag(GtkEntry *entry, enum text_tag_type type)
{
  char buf[MAX_LEN_MSG];
  GtkEditable *editable = GTK_EDITABLE(entry);
  gint start_pos, end_pos;
  gchar *selection;
  gchar *fg_color_text = NULL, *bg_color_text = NULL;
 
  if (!gtk_editable_get_selection_bounds(editable, &start_pos, &end_pos)) {
    /* Let's say the selection starts and ends at the current position. */
    start_pos = end_pos = gtk_editable_get_position(editable);
  }
 
  selection = gtk_editable_get_chars(editable, start_pos, end_pos);
 
  if (type == TTT_COLOR) {
    /* Get the color arguments. */
    GdkRGBA *fg_color = g_object_get_data(G_OBJECT(entry), "fg_color");
    GdkRGBA *bg_color = g_object_get_data(G_OBJECT(entry), "bg_color");
 
    if (!fg_color && !bg_color) {
      goto CLEAN_UP;
    }
 
    if (fg_color) {
      fg_color_text = gdk_rgba_to_string(fg_color);
    }
    if (bg_color) {
      bg_color_text = gdk_rgba_to_string(bg_color);
    }
 
    if (0 == featured_text_apply_tag(selection, buf, sizeof(buf),
                                     TTT_COLOR, 0, FT_OFFSET_UNSET,
                                     ft_color_construct(fg_color_text,
                                                        bg_color_text))) {
      goto CLEAN_UP;
    }
  } else if (0 == featured_text_apply_tag(selection, buf, sizeof(buf),
                                          type, 0, FT_OFFSET_UNSET)) {
    goto CLEAN_UP;
  }
 
  /* Replace the selection. */
  gtk_editable_delete_text(editable, start_pos, end_pos);
  end_pos = start_pos;
  gtk_editable_insert_text(editable, buf, -1, &end_pos);
  gtk_editable_select_region(editable, start_pos, end_pos);
 
CLEAN_UP:
  g_free(selection);
  g_free(fg_color_text);
  g_free(bg_color_text);
}
 
/**********************************************************************/
void inputline_make_chat_link(struct tile *ptile, bool unit)
{
  char buf[MAX_LEN_MSG];
  GtkWidget *entry = toolkit.entry;
  GtkEditable *editable = GTK_EDITABLE(entry);
  gint start_pos, end_pos;
  gchar *chars;
  struct unit *punit;
 
  /* Get the target. */
  if (unit) {
    punit = find_visible_unit(ptile);
    if (!punit) {
      output_window_append(ftc_client, _("No visible unit on this tile."));
      return;
    }
  } else {
    punit = NULL;
  }
 
  if (gtk_editable_get_selection_bounds(editable, &start_pos, &end_pos)) {
    /* There is a selection, make it clickable. */
    gpointer target;
    enum text_link_type type;
 
    chars = gtk_editable_get_chars(editable, start_pos, end_pos);
    if (punit) {
      type = TLT_UNIT;
      target = punit;
    } else if (tile_city(ptile)) {
      type = TLT_CITY;
      target = tile_city(ptile);
    } else {
      type = TLT_TILE;
      target = ptile;
    }
 
    if (0 != featured_text_apply_tag(chars, buf, sizeof(buf), TTT_LINK,
                                     0, FT_OFFSET_UNSET, type, target)) {
      /* Replace the selection. */
      gtk_editable_delete_text(editable, start_pos, end_pos);
      end_pos = start_pos;
      gtk_editable_insert_text(editable, buf, -1, &end_pos);
      gtk_widget_grab_focus(entry);
      gtk_editable_select_region(editable, start_pos, end_pos);
    }
  } else {
    /* Just insert the link at the current position. */
    start_pos = gtk_editable_get_position(editable);
    end_pos = start_pos;
    chars = gtk_editable_get_chars(editable, MAX(start_pos - 1, 0),
                                   start_pos + 1);
    if (punit) {
      sz_strlcpy(buf, unit_link(punit));
    } else if (tile_city(ptile)) {
      sz_strlcpy(buf, city_link(tile_city(ptile)));
    } else {
      sz_strlcpy(buf, tile_link(ptile));
    }
 
    if (start_pos > 0 && strlen(chars) > 0 && chars[0] != ' ') {
      /* Maybe insert an extra space. */
      gtk_editable_insert_text(editable, " ", 1, &end_pos);
    }
    gtk_editable_insert_text(editable, buf, -1, &end_pos);
    if (chars[start_pos > 0 ? 1 : 0] != '\0'
        && chars[start_pos > 0 ? 1 : 0] != ' ') {
      /* Maybe insert an extra space. */
      gtk_editable_insert_text(editable, " ", 1, &end_pos);
    }
    gtk_widget_grab_focus(entry);
    gtk_editable_set_position(editable, end_pos);
  }
 
  g_free(chars);
}
 
/**********************************************************************/
void scroll_if_necessary(GtkTextView *textview, GtkTextMark *scroll_target)
{
  GtkWidget *sw;
  GtkAdjustment *vadj;
  gdouble val, max, upper, page_size;
 
  fc_assert_ret(textview != NULL);
  fc_assert_ret(scroll_target != NULL);
 
  sw = gtk_widget_get_parent(GTK_WIDGET(textview));
  fc_assert_ret(sw != NULL);
  fc_assert_ret(GTK_IS_SCROLLED_WINDOW(sw));
 
  vadj = gtk_scrolled_window_get_vadjustment(GTK_SCROLLED_WINDOW(sw));
  val = gtk_adjustment_get_value(vadj);
  g_object_get(G_OBJECT(vadj), "upper", &upper,
               "page-size", &page_size, NULL);
  max = upper - page_size;
  if (max - val < 10.0) {
    gtk_text_view_scroll_to_mark(GTK_TEXT_VIEW(textview), scroll_target,
                                 0.0, TRUE, 1.0, 0.0);
  }
}
 
/**********************************************************************/
static gboolean event_after(GtkGestureClick *gesture, int n_press,
                            double x, double y, gpointer data)
{
  GtkWidget *text_view = gtk_event_controller_get_widget(GTK_EVENT_CONTROLLER(gesture));
  GtkTextIter start, end, iter;
  GtkTextBuffer *buffer;
  GSList *tags, *tagp;
  gint bx, by;
  struct tile *ptile = NULL;
 
  buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text_view));
 
  /* We shouldn't follow a link if the user has selected something. */
  gtk_text_buffer_get_selection_bounds(buffer, &start, &end);
  if (gtk_text_iter_get_offset(&start) != gtk_text_iter_get_offset(&end)) {
    return FALSE;
  }
 
  gtk_text_view_window_to_buffer_coords(GTK_TEXT_VIEW (text_view),
                                        GTK_TEXT_WINDOW_WIDGET,
                                        x, y, &bx, &by);
 
  gtk_text_view_get_iter_at_location(GTK_TEXT_VIEW(text_view), &iter, bx, by);
 
  if ((tags = gtk_text_iter_get_tags(&iter))) {
    for (tagp = tags; tagp; tagp = tagp->next) {
      GtkTextTag *tag = tagp->data;
      enum text_link_type type =
        GPOINTER_TO_INT(g_object_get_data(G_OBJECT(tag), "type"));
 
      if (type != 0) {
        /* This is a link. */
        int id = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(tag), "id"));
        ptile = NULL;
 
        /* Real type is type - 1.
         * See comment in apply_text_tag() for g_object_set_data(). */
        type--;
 
        switch (type) {
        case TLT_CITY:
          {
            struct city *pcity = game_city_by_number(id);
 
            if (pcity) {
              ptile = client_city_tile(pcity);
            } else {
              output_window_append(ftc_client, _("This city isn't known!"));
            }
          }
          break;
        case TLT_TILE:
          ptile = index_to_tile(&(wld.map), id);
 
          if (!ptile) {
            output_window_append(ftc_client,
                                 _("This tile doesn't exist in this game!"));
          }
          break;
        case TLT_UNIT:
          {
            struct unit *punit = game_unit_by_number(id);
 
            if (punit) {
              ptile = unit_tile(punit);
            } else {
              output_window_append(ftc_client, _("This unit isn't known!"));
            }
          }
          break;
        }
 
        if (ptile) {
          center_tile_mapcanvas(ptile);
          link_mark_restore(type, id);
          gtk_widget_grab_focus(GTK_WIDGET(map_canvas));
        }
      }
    }
    g_slist_free(tags);
  }
 
  return FALSE;
}
 
/**********************************************************************/
static void set_cursor_if_appropriate(GtkTextView *text_view, gint x, gint y)
{
  static gboolean hovering_over_link = FALSE;
  static GdkCursor *hand_cursor = NULL;
  static GdkCursor *regular_cursor = NULL;
  GSList *tags, *tagp;
  GtkTextIter iter;
  gboolean hovering = FALSE;
 
  /* Initialize the cursors. */
  if (!hand_cursor) {
    hand_cursor = gdk_cursor_new_from_name("pointer", NULL);
  }
  if (!regular_cursor) {
    regular_cursor = gdk_cursor_new_from_name("text", NULL);
  }
 
  gtk_text_view_get_iter_at_location(text_view, &iter, x, y);
 
  tags = gtk_text_iter_get_tags(&iter);
  for (tagp = tags; tagp; tagp = tagp->next) {
    enum text_link_type type =
      GPOINTER_TO_INT(g_object_get_data(G_OBJECT(tagp->data), "type"));
 
    if (type != 0) {
      hovering = TRUE;
      break;
    }
  }
 
  if (hovering != hovering_over_link) {
    hovering_over_link = hovering;
 
    if (hovering_over_link) {
      gtk_widget_set_cursor(GTK_WIDGET(text_view), hand_cursor);
    } else {
      gtk_widget_set_cursor(GTK_WIDGET(text_view), regular_cursor);
    }
  }
 
  if (tags) {
    g_slist_free(tags);
  }
}
 
/**********************************************************************/
static gboolean chat_pointer_motion(GtkEventControllerMotion *controller,
                                    gdouble e_x, gdouble e_y, gpointer data)
{
  gint x, y;
  GtkWidget *text_view
    = gtk_event_controller_get_widget(GTK_EVENT_CONTROLLER(controller));
 
  gtk_text_view_window_to_buffer_coords(GTK_TEXT_VIEW(text_view),
                                        GTK_TEXT_WINDOW_WIDGET,
                                        e_x, e_y, &x, &y);
  set_cursor_if_appropriate(GTK_TEXT_VIEW(text_view), x, y);
 
  return FALSE;
}
 
/**********************************************************************/
void set_message_buffer_view_link_handlers(GtkWidget *view)
{
  GtkGesture *gesture;
  GtkEventController *controller;
 
  gesture = gtk_gesture_click_new();
  controller = GTK_EVENT_CONTROLLER(gesture);
  g_signal_connect(controller, "released",
                   G_CALLBACK(event_after), NULL);
  gtk_widget_add_controller(view, controller);
 
  controller = GTK_EVENT_CONTROLLER(gtk_event_controller_motion_new());
  g_signal_connect(controller, "motion",
                   G_CALLBACK(chat_pointer_motion), NULL);
  gtk_widget_add_controller(view, controller);
}
 
/**********************************************************************/
void apply_text_tag(const struct text_tag *ptag, GtkTextBuffer *buf,
                    ft_offset_t text_start_offset, const char *text)
{
  static bool initialized = FALSE;
  GtkTextIter start, stop;
 
  if (!initialized) {
    gtk_text_buffer_create_tag(buf, "bold",
                               "weight", PANGO_WEIGHT_BOLD, NULL);
    gtk_text_buffer_create_tag(buf, "italic",
                               "style", PANGO_STYLE_ITALIC, NULL);
    gtk_text_buffer_create_tag(buf, "strike",
                               "strikethrough", TRUE, NULL);
    gtk_text_buffer_create_tag(buf, "underline",
                               "underline", PANGO_UNDERLINE_SINGLE, NULL);
    initialized = TRUE;
  }
 
  /* Get the position. */
  /*
   * N.B.: text_tag_*_offset() value is in bytes, so we need to convert it
   * to utf8 character offset.
   */
  gtk_text_buffer_get_iter_at_offset(buf, &start, text_start_offset
                                     + g_utf8_pointer_to_offset(text,
                                     text + text_tag_start_offset(ptag)));
  if (text_tag_stop_offset(ptag) == FT_OFFSET_UNSET) {
    gtk_text_buffer_get_end_iter(buf, &stop);
  } else {
    gtk_text_buffer_get_iter_at_offset(buf, &stop, text_start_offset
                                       + g_utf8_pointer_to_offset(text,
                                       text + text_tag_stop_offset(ptag)));
  }
 
  switch (text_tag_type(ptag)) {
  case TTT_BOLD:
    gtk_text_buffer_apply_tag_by_name(buf, "bold", &start, &stop);
    break;
  case TTT_ITALIC:
    gtk_text_buffer_apply_tag_by_name(buf, "italic", &start, &stop);
    break;
  case TTT_STRIKE:
    gtk_text_buffer_apply_tag_by_name(buf, "strike", &start, &stop);
    break;
  case TTT_UNDERLINE:
    gtk_text_buffer_apply_tag_by_name(buf, "underline", &start, &stop);
    break;
  case TTT_COLOR:
    {
      /* We have to make a new tag every time. */
      GtkTextTag *tag = NULL;
      const char *foreground = text_tag_color_foreground(ptag);
      const char *background = text_tag_color_background(ptag);
 
      if (foreground && foreground[0]) {
        if (background && background[0]) {
          tag = gtk_text_buffer_create_tag(buf, NULL,
                                           "foreground", foreground,
                                           "background", background,
                                           NULL);
        } else {
          tag = gtk_text_buffer_create_tag(buf, NULL,
                                           "foreground", foreground,
                                           NULL);
        }
      } else if (background && background[0]) {
        tag = gtk_text_buffer_create_tag(buf, NULL,
                                         "background", background,
                                         NULL);
      }
 
      if (!tag) {
        break; /* No color. */
      }
      gtk_text_buffer_apply_tag(buf, tag, &start, &stop);
    }
    break;
  case TTT_LINK:
    {
      struct color *pcolor = NULL;
      GtkTextTag *tag;
 
      switch (text_tag_link_type(ptag)) {
      case TLT_CITY:
        pcolor = get_color(tileset, COLOR_MAPVIEW_CITY_LINK);
        break;
      case TLT_TILE:
        pcolor = get_color(tileset, COLOR_MAPVIEW_TILE_LINK);
        break;
      case TLT_UNIT:
        pcolor = get_color(tileset, COLOR_MAPVIEW_UNIT_LINK);
        break;
      }
 
      if (!pcolor) {
        break; /* Not a valid link type case. */
      }
 
      tag = gtk_text_buffer_create_tag(buf, NULL,
                                       "foreground-rgba", &pcolor->color,
                                       "underline", PANGO_UNDERLINE_SINGLE,
                                       NULL);
 
      /* Type 0 is reserved for non-link tags.  So, add 1 to the
       * type value. */
      g_object_set_data(G_OBJECT(tag), "type",
                        GINT_TO_POINTER(text_tag_link_type(ptag) + 1));
      g_object_set_data(G_OBJECT(tag), "id",
                        GINT_TO_POINTER(text_tag_link_id(ptag)));
      gtk_text_buffer_apply_tag(buf, tag, &start, &stop);
      break;
    }
  }
}
 
/**********************************************************************/
void real_output_window_append(const char *astring,
                               const struct text_tag_list *tags,
                               int conn_id)
{
  GtkTextBuffer *buf;
  GtkTextIter iter;
  GtkTextMark *mark;
  ft_offset_t text_start_offset;
 
  buf = message_buffer;
 
  if (buf == NULL) {
    log_error("Output when no message buffer: %s", astring);
 
    return;
  }
 
  gtk_text_buffer_get_end_iter(buf, &iter);
  gtk_text_buffer_insert(buf, &iter, "\n", -1);
  mark = gtk_text_buffer_create_mark(buf, NULL, &iter, TRUE);
 
  if (GUI_GTK_OPTION(show_chat_message_time)) {
    char timebuf[64];
    time_t now;
    struct tm now_tm;
 
    now = time(NULL);
    fc_localtime(&now, &now_tm);
    strftime(timebuf, sizeof(timebuf), "[%H:%M:%S] ", &now_tm);
    gtk_text_buffer_insert(buf, &iter, timebuf, -1);
  }
 
  text_start_offset = gtk_text_iter_get_offset(&iter);
  gtk_text_buffer_insert(buf, &iter, astring, -1);
  text_tag_list_iterate(tags, ptag) {
    apply_text_tag(ptag, buf, text_start_offset, astring);
  } text_tag_list_iterate_end;
 
  if (main_message_area) {
    scroll_if_necessary(GTK_TEXT_VIEW(main_message_area), mark);
  }
  if (start_message_area) {
    scroll_if_necessary(GTK_TEXT_VIEW(start_message_area), mark);
  }
  gtk_text_buffer_delete_mark(buf, mark);
 
  append_network_statusbar(astring, FALSE);
}
 
/**********************************************************************/
void log_output_window(void)
{
  GtkTextIter start, end;
  gchar *txt;
 
  gtk_text_buffer_get_bounds(message_buffer, &start, &end);
  txt = gtk_text_buffer_get_text(message_buffer, &start, &end, TRUE);
 
  write_chatline_content(txt);
  g_free(txt);
}
 
/**********************************************************************/
void clear_output_window(void)
{
  set_output_window_text(_("Cleared output window."));
}
 
/**********************************************************************/
void set_output_window_text(const char *text)
{
  gtk_text_buffer_set_text(message_buffer, text, -1);
}
 
/**********************************************************************/
bool chatline_is_scrolled_to_bottom(void)
{
  GtkWidget *sw, *w;
  GtkAdjustment *vadj;
  gdouble val, max, upper, page_size;
 
  if (get_client_page() == PAGE_GAME) {
    w = GTK_WIDGET(main_message_area);
  } else {
    w = GTK_WIDGET(start_message_area);
  }
 
  if (w == NULL) {
    return TRUE;
  }
 
  sw = gtk_widget_get_parent(w);
  vadj = gtk_scrolled_window_get_vadjustment(GTK_SCROLLED_WINDOW(sw));
  val = gtk_adjustment_get_value(vadj);
  g_object_get(G_OBJECT(vadj), "upper", &upper,
               "page-size", &page_size, NULL);
  max = upper - page_size;
 
  /* Approximation. */
  return max - val < 0.00000001;
}
 
/**********************************************************************/
static gboolean chatline_scroll_callback(gpointer data)
{
  chatline_scroll_to_bottom(FALSE);     /* Not delayed this time! */
 
  *((guint *) data) = 0;
  return FALSE;         /* Remove this idle function. */
}
 
/**********************************************************************/
void chatline_scroll_to_bottom(bool delayed)
{
  static guint callback_id = 0;
 
  if (delayed) {
    if (callback_id == 0) {
      callback_id = g_idle_add(chatline_scroll_callback, &callback_id);
    }
  } else if (message_buffer) {
    GtkTextIter end;
 
    gtk_text_buffer_get_end_iter(message_buffer, &end);
 
    if (main_message_area) {
      gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(main_message_area),
                                   &end, 0.0, TRUE, 1.0, 0.0);
    }
    if (start_message_area) {
      gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(start_message_area),
                                   &end, 0.0, TRUE, 1.0, 0.0);
    }
  }
}
 
/**********************************************************************/
static void make_tag_callback(GtkButton *button, gpointer data)
{
  inputline_make_tag(GTK_ENTRY(data),
                     GPOINTER_TO_INT(g_object_get_data(G_OBJECT(button),
                                                       "text_tag_type")));
}
 
/**********************************************************************/
static void color_set(GObject *object, const gchar *color_target,
                      GdkRGBA *color, GtkButton *button)
{
  GdkRGBA *current_color = g_object_get_data(object, color_target);
 
  if (NULL == color) {
    /* Clears the current color. */
    if (NULL != current_color) {
      gdk_rgba_free(current_color);
      g_object_set_data(object, color_target, NULL);
      if (NULL != button) {
        gtk_button_set_child(button, NULL);
      }
    }
  } else {
    /* Apply the new color. */
    if (NULL != current_color) {
      /* We already have a GdkRGBA pointer. */
      *current_color = *color;
    } else {
      /* We need to make a GdkRGBA pointer. */
      current_color = gdk_rgba_copy(color);
      g_object_set_data(object, color_target, current_color);
    }
 
    if (NULL != button) {
      /* Update the button. */
      GdkPixbuf *pixbuf;
      GtkWidget *image;
 
      gtk_button_set_child(button, NULL);
 
      {
        cairo_surface_t *surface = cairo_image_surface_create(
            CAIRO_FORMAT_RGB24, 16, 16);
        cairo_t *cr = cairo_create(surface);
 
        gdk_cairo_set_source_rgba(cr, current_color);
        cairo_paint(cr);
        cairo_destroy(cr);
        pixbuf = gdk_pixbuf_get_from_surface(surface, 0, 0, 16, 16);
        cairo_surface_destroy(surface);
      }
      image = gtk_image_new_from_pixbuf(pixbuf);
      gtk_button_set_child(button, image);
      gtk_widget_set_visible(image, TRUE);
      g_object_unref(G_OBJECT(pixbuf));
    }
  }
}
 
/**********************************************************************/
static void color_selected(GtkDialog *dialog, gint res, gpointer data)
{
  const gchar *color_target =
    g_object_get_data(G_OBJECT(data), "color_target");
  GObject *entry = g_object_get_data(G_OBJECT(data), "entry");
 
  if (res == GTK_RESPONSE_REJECT) {
    /* Clears the current color. */
    color_set(entry, color_target, NULL, data);
  } else if (res == GTK_RESPONSE_OK) {
    /* Apply the new color. */
    GtkColorChooser *chooser =
      GTK_COLOR_CHOOSER(g_object_get_data(G_OBJECT(dialog), "chooser"));
    GdkRGBA new_color;
 
    gtk_color_chooser_get_rgba(chooser, &new_color);
    color_set(entry, color_target, &new_color, data);
  }
 
  gtk_window_destroy(GTK_WINDOW(dialog));
}
 
/**********************************************************************/
static void select_color_callback(GtkButton *button, gpointer data)
{
  GtkWidget *dialog, *chooser;
  /* "fg_color" or "bg_color". */
  const gchar *color_target = g_object_get_data(G_OBJECT(button),
                                                "color_target");
  GdkRGBA *current_color = g_object_get_data(G_OBJECT(data), color_target);
 
  /* TRANS: "text" or "background". */
  gchar *buf = g_strdup_printf(_("Select the %s color"),
              (const char *) g_object_get_data(G_OBJECT(button),
                                               "color_info"));
  dialog = gtk_dialog_new_with_buttons(buf, NULL, GTK_DIALOG_MODAL,
                                       _("_Cancel"), GTK_RESPONSE_CANCEL,
                                       _("C_lear"), GTK_RESPONSE_REJECT,
                                       _("_OK"), GTK_RESPONSE_OK, NULL);
  setup_dialog(dialog, toplevel);
  g_object_set_data(G_OBJECT(button), "entry", data);
  g_signal_connect(dialog, "response", G_CALLBACK(color_selected), button);
 
  chooser = gtk_color_chooser_widget_new();
  gtk_box_insert_child_after(GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dialog))),
                             chooser, NULL);
  g_object_set_data(G_OBJECT(dialog), "chooser", chooser);
 
  if (current_color != NULL) {
    gtk_color_chooser_set_rgba(GTK_COLOR_CHOOSER(chooser), current_color);
  }
 
  gtk_widget_set_visible(dialog, TRUE);
  g_free(buf);
}
 
/**********************************************************************/
static gboolean move_toolkit(GtkWidget *toolkit_view, gpointer data)
{
  struct inputline_toolkit *ptoolkit = (struct inputline_toolkit *) data;
  GtkWidget *parent = gtk_widget_get_parent(ptoolkit->main_widget);
  GtkWidget *button_box = GTK_WIDGET(g_object_get_data(G_OBJECT(toolkit_view),
                                                       "button_box"));
  GtkWidget *iter;
 
  if (parent) {
    if (parent == toolkit_view) {
      return FALSE;     /* Already owned. */
    }
 
    /* N.B.: We need to hide/show the toolbar to reset the sensitivity
     * of the tool buttons. */
    if (ptoolkit->toolbar_displayed) {
      gtk_widget_set_visible(ptoolkit->toolbar, FALSE);
    }
    g_object_ref(ptoolkit->main_widget); /* Make sure reference count stays above 0
                                          * during the transition to new parent. */
    gtk_box_remove(GTK_BOX(parent), ptoolkit->main_widget);
    gtk_box_append(GTK_BOX(toolkit_view), ptoolkit->main_widget);
    g_object_unref(ptoolkit->main_widget);
    if (ptoolkit->toolbar_displayed) {
      gtk_widget_set_visible(ptoolkit->toolbar, TRUE);
    }
 
    if (!gtk_widget_get_parent(button_box)) {
      /* Attach to the toolkit button_box. */
      gtk_box_append(GTK_BOX(ptoolkit->button_box), button_box);
    }
    gtk_widget_set_visible(button_box, TRUE);
    if (!ptoolkit->toolbar_displayed) {
      gtk_widget_set_visible(ptoolkit->toolbar, FALSE);
    }
 
    /* Hide all other buttons boxes. */
    for (iter = gtk_widget_get_first_child(GTK_WIDGET(ptoolkit->button_box));
         iter != NULL;
         iter = gtk_widget_get_next_sibling(iter)) {
      if (iter != button_box) {
        gtk_widget_set_visible(iter, FALSE);
      }
    }
 
  } else {
    /* First time attached to a parent. */
    gtk_box_append(GTK_BOX(toolkit_view), ptoolkit->main_widget);
    gtk_box_append(GTK_BOX(ptoolkit->button_box), button_box);
    gtk_widget_set_visible(ptoolkit->main_widget, TRUE);
  }
 
  return FALSE;
}
 
/**********************************************************************/
static gboolean set_toolbar_visibility(GtkWidget *w, gpointer data)
{
  struct inputline_toolkit *ptoolkit = (struct inputline_toolkit *) data;
  GtkToggleButton *button = GTK_TOGGLE_BUTTON(toolkit.toggle_button);
 
  if (ptoolkit->toolbar_displayed) {
    if (!gtk_toggle_button_get_active(button)) {
      /* button_toggled() will be called and the toolbar shown. */
      gtk_toggle_button_set_active(button, TRUE);
    } else {
      /* Ensure the widget is visible. */
      gtk_widget_set_visible(ptoolkit->toolbar, TRUE);
    }
  } else {
    if (gtk_toggle_button_get_active(button)) {
      /* button_toggled() will be called and the toolbar hidden. */
      gtk_toggle_button_set_active(button, FALSE);
    } else {
      /* Ensure the widget is not visible. */
      gtk_widget_set_visible(ptoolkit->toolbar, FALSE);
    }
  }
 
  return FALSE;
}
 
/**********************************************************************/
static void button_toggled(GtkToggleButton *button, gpointer data)
{
  struct inputline_toolkit *ptoolkit = (struct inputline_toolkit *) data;
 
  if (gtk_toggle_button_get_active(button)) {
    gtk_widget_set_visible(ptoolkit->toolbar, TRUE);
    ptoolkit->toolbar_displayed = TRUE;
    if (chatline_is_scrolled_to_bottom()) {
      /* Make sure to be still at the end. */
      chatline_scroll_to_bottom(TRUE);
    }
  } else {
    gtk_widget_set_visible(ptoolkit->toolbar, FALSE);
    ptoolkit->toolbar_displayed = FALSE;
  }
}
 
/**********************************************************************/
GtkWidget *inputline_toolkit_view_new(void)
{
  GtkWidget *toolkit_view, *bbox;
 
  /* Main widget. */
  toolkit_view = gtk_box_new(GTK_ORIENTATION_VERTICAL, 2);
  g_signal_connect_after(toolkit_view, "map",
                         G_CALLBACK(move_toolkit), &toolkit);
 
  /* Button box. */
  bbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 12);
  g_object_set_data(G_OBJECT(toolkit_view), "button_box", bbox);
 
  return toolkit_view;
}
 
/**********************************************************************/
void inputline_toolkit_view_append_button(GtkWidget *toolkit_view,
                                          GtkWidget *button)
{
  gtk_box_append(GTK_BOX(g_object_get_data(G_OBJECT(toolkit_view),
                                           "button_box")), button);
}
 
/**********************************************************************/
void chatline_init(void)
{
  GtkWidget *vbox, *hgrid, *entry, *bbox;
  GtkWidget *button;
  GtkWidget *toolbar;
  GtkWidget *item;
  GdkRGBA color;
  int grid_col = 0;
  GtkEventController *chat_controller;
  GtkEventController *focus_controller;
 
  /* Chatline history. */
  if (!history_list) {
    history_list = genlist_new();
    history_pos = -1;
  }
 
  /* Inputline toolkit. */
  memset(&toolkit, 0, sizeof(toolkit));
 
  vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 2);
 
  toolkit.main_widget = vbox;
  g_signal_connect_after(vbox, "map",
                         G_CALLBACK(set_toolbar_visibility), &toolkit);
 
  entry = gtk_entry_new();
  gtk_widget_set_margin_bottom(entry, 2);
  gtk_widget_set_margin_end(entry, 2);
  gtk_widget_set_margin_start(entry, 2);
  gtk_widget_set_margin_top(entry, 2);
  gtk_widget_set_hexpand(entry, TRUE);
  focus_controller = GTK_EVENT_CONTROLLER(gtk_event_controller_focus_new());
  g_signal_connect(focus_controller, "enter",
                   G_CALLBACK(il_gained_focus), NULL);
  g_signal_connect(focus_controller, "leave",
                   G_CALLBACK(il_lost_focus), NULL);
  gtk_widget_add_controller(entry, focus_controller);
  toolkit.entry = entry;
 
  hgrid = gtk_grid_new();
  gtk_grid_set_column_spacing(GTK_GRID(hgrid), 4);
 
  /* First line: toolbar */
  toolbar = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 2);
  gtk_box_append(GTK_BOX(vbox), toolbar);
  toolkit.toolbar = toolbar;
 
  /* Bold button. */
  item = gtk_button_new_from_icon_name("format-text-bold");
 
  /* _("Bold")); */
 
  gtk_box_append(GTK_BOX(toolbar), item);
  g_object_set_data(G_OBJECT(item), "text_tag_type",
                    GINT_TO_POINTER(TTT_BOLD));
  g_signal_connect(item, "clicked", G_CALLBACK(make_tag_callback), entry);
  gtk_widget_set_tooltip_text(GTK_WIDGET(item), _("Bold (Ctrl-B)"));
 
  /* Italic button. */
  item = gtk_button_new_from_icon_name("format-text-italic");
 
  /* _("Italic")); */
 
  gtk_box_append(GTK_BOX(toolbar), item);
  g_object_set_data(G_OBJECT(item), "text_tag_type",
                    GINT_TO_POINTER(TTT_ITALIC));
  g_signal_connect(item, "clicked", G_CALLBACK(make_tag_callback), entry);
  gtk_widget_set_tooltip_text(GTK_WIDGET(item), _("Italic (Ctrl-I)"));
 
  /* Strike button. */
  item = gtk_button_new_from_icon_name("format-text-strikethrough");
 
  /* _("Strikethrough")); */
  gtk_box_append(GTK_BOX(toolbar), item);
  g_object_set_data(G_OBJECT(item), "text_tag_type",
                    GINT_TO_POINTER(TTT_STRIKE));
  g_signal_connect(item, "clicked", G_CALLBACK(make_tag_callback), entry);
  gtk_widget_set_tooltip_text(GTK_WIDGET(item), _("Strikethrough (Ctrl-S)"));
 
  /* Underline button. */
  item = gtk_button_new_from_icon_name("format-text-underline");
 
  /* _("Underline")); */
  gtk_box_append(GTK_BOX(toolbar), item);
  g_object_set_data(G_OBJECT(item), "text_tag_type",
                    GINT_TO_POINTER(TTT_UNDERLINE));
  g_signal_connect(item, "clicked", G_CALLBACK(make_tag_callback), entry);
  gtk_widget_set_tooltip_text(GTK_WIDGET(item), _("Underline (Ctrl-U)"));
 
  gtk_box_append(GTK_BOX(toolbar), gtk_separator_new(GTK_ORIENTATION_HORIZONTAL));
 
  /* Color button. */
  item = gtk_button_new_with_label(_("Color"));
 
  gtk_box_append(GTK_BOX(toolbar), item);
  g_object_set_data(G_OBJECT(item), "text_tag_type",
                    GINT_TO_POINTER(TTT_COLOR));
  g_signal_connect(item, "clicked", G_CALLBACK(make_tag_callback), entry);
  gtk_widget_set_tooltip_text(GTK_WIDGET(item), _("Color (Ctrl-C)"));
 
  gtk_box_append(GTK_BOX(toolbar), gtk_separator_new(GTK_ORIENTATION_HORIZONTAL));
 
  /* Foreground selector. */
  item = gtk_button_new();
  gtk_box_append(GTK_BOX(toolbar), item);
  g_object_set_data(G_OBJECT(item), "color_target", fc_strdup("fg_color"));
  g_object_set_data(G_OBJECT(item), "color_info",
                    fc_strdup(_("foreground")));
  g_signal_connect(item, "clicked",
                   G_CALLBACK(select_color_callback), entry);
  gtk_widget_set_tooltip_text(GTK_WIDGET(item), _("Select the text color"));
  if (gdk_rgba_parse(&color, "#000000")) {
    /* Set default foreground color. */
    color_set(G_OBJECT(entry), "fg_color", &color, GTK_BUTTON(item));
  } else {
    log_error("Failed to set the default foreground color.");
  }
 
  /* Background selector. */
  item = gtk_button_new();
  gtk_box_append(GTK_BOX(toolbar), item);
  g_object_set_data(G_OBJECT(item), "color_target", fc_strdup("bg_color"));
  g_object_set_data(G_OBJECT(item), "color_info",
                    fc_strdup(_("background")));
  g_signal_connect(item, "clicked",
                   G_CALLBACK(select_color_callback), entry);
  gtk_widget_set_tooltip_text(GTK_WIDGET(item),
                              _("Select the background color"));
  if (gdk_rgba_parse(&color, "#ffffff")) {
    /* Set default background color. */
    color_set(G_OBJECT(entry), "bg_color", &color, GTK_BUTTON(item));
  } else {
    log_error("Failed to set the default background color.");
  }
 
  gtk_box_append(GTK_BOX(toolbar), gtk_separator_new(GTK_ORIENTATION_HORIZONTAL));
 
  /* Return button. */
  item = gtk_button_new_with_label(_("OK"));
  gtk_box_append(GTK_BOX(toolbar), item);
  g_signal_connect_swapped(item, "clicked",
                           G_CALLBACK(inputline_return), entry);
  gtk_widget_set_tooltip_text(GTK_WIDGET(item),
                              /* TRANS: "Return" means the return key. */
                              _("Send the chat (Return)"));
 
  /* Second line */
  gtk_box_append(GTK_BOX(vbox), hgrid);
 
  /* Toggle button. */
  button = gtk_toggle_button_new();
  gtk_widget_set_margin_bottom(button, 2);
  gtk_widget_set_margin_end(button, 2);
  gtk_widget_set_margin_start(button, 2);
  gtk_widget_set_margin_top(button, 2);
  gtk_grid_attach(GTK_GRID(hgrid), button, grid_col++, 0, 1, 1);
  gtk_button_set_icon_name(GTK_BUTTON(button), "insert-link");
  g_signal_connect(button, "toggled", G_CALLBACK(button_toggled), &toolkit);
  gtk_widget_set_tooltip_text(GTK_WIDGET(button), _("Chat tools"));
  toolkit.toggle_button = button;
 
  /* Entry. */
  gtk_grid_attach(GTK_GRID(hgrid), entry, grid_col++, 0, 1, 1);
  g_signal_connect(entry, "activate", G_CALLBACK(inputline_return), NULL);
 
  chat_controller = gtk_event_controller_key_new();
  g_signal_connect(chat_controller, "key-pressed",
                   G_CALLBACK(inputline_handler), NULL);
  gtk_widget_add_controller(entry, chat_controller);
 
  /* Button box. */
  bbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 2);
  gtk_grid_attach(GTK_GRID(hgrid), bbox, grid_col++, 0, 1, 1);
  toolkit.button_box = bbox;
}
 
/**********************************************************************/
static gboolean version_message_main_thread(gpointer user_data)
{
  char *vertext = (char *)user_data;
 
  output_window_append(ftc_client, vertext);
 
  FC_FREE(vertext);
 
  return G_SOURCE_REMOVE;
}
 
/**********************************************************************/
void version_message(const char *vertext)
{
  int len = strlen(vertext) + 1;
  char *persistent = fc_malloc(len);
 
  strncpy(persistent, vertext, len);
 
  g_idle_add(version_message_main_thread, persistent);
}