mapview.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>
 
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
 
#include <gtk/gtk.h>
 
/* utility */
#include "fcintl.h"
#include "log.h"
#include "mem.h"
#include "rand.h"
#include "support.h"
#include "timing.h"
 
/* common */
#include "game.h"
#include "government.h"         /* government_graphic() */
#include "map.h"
#include "player.h"
 
/* client */
#include "client_main.h"
#include "climap.h"
#include "climisc.h"
#include "colors.h"
#include "control.h" /* get_unit_in_focus() */
#include "editor.h"
#include "options.h"
#include "overview_common.h"
#include "tilespec.h"
#include "text.h"
#include "zoom.h"
 
/* client/gui-gtk-3.22 */
#include "citydlg.h" /* For reset_city_dialogs() */
#include "editgui.h"
#include "graphics.h"
#include "gui_main.h"
#include "gui_stuff.h"
#include "mapctrl.h"
#include "repodlgs.h"
#include "wldlg.h"
 
#include "mapview.h"
 
static GtkAdjustment *map_hadj, *map_vadj;
static int cursor_timer_id = 0, cursor_type = -1, cursor_frame = 0;
static int mapview_frozen_level = 0;
 
/**********************************************************************/
void update_turn_done_button(bool do_restore)
{
  static bool flip = FALSE;
 
  if (!get_turn_done_button_state()) {
    return;
  }
 
  if ((do_restore && flip) || !do_restore) {
    static GtkCssProvider *tdb_provider = NULL;
    GtkStyleContext *scontext = gtk_widget_get_style_context(turn_done_button);
 
    if (tdb_provider == NULL) {
      tdb_provider = gtk_css_provider_new();
 
      gtk_css_provider_load_from_data(tdb_provider,
                                      ".lighted {\n"
                                      "color: rgba(235, 127, 235, 255);\n"
                                      "background-color: rgba(127, 127, 127, 255);\n"
                                      "}\n",
                                      -1, NULL);
 
      /* Turn Done button is persistent, so we only need to do this
       * once too. */
      gtk_style_context_add_provider(scontext,
                                     GTK_STYLE_PROVIDER(tdb_provider),
                                     GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
    }
 
    if (flip) {
      gtk_style_context_add_class(scontext, "lighted");
    } else {
      gtk_style_context_remove_class(scontext, "lighted");
    }
 
    flip = !flip;
  }
}
 
/**********************************************************************/
void update_timeout_label(void)
{
  gtk_label_set_text(GTK_LABEL(timeout_label), get_timeout_label_text());
 
  if (current_turn_timeout() > 0) {
    gtk_widget_set_tooltip_text(timeout_label,
                                _("Time to forced turn change,\n"
                                  "or estimated time to finish turn change "
                                  "processing."));
  } else {
    gtk_widget_set_tooltip_text(timeout_label,
                                _("Turn timeout disabled.\n"
                                  "Between turns this shows estimated time "
                                  "to finish turn change processing."));
  }
}
 
/**********************************************************************/
void update_info_label(void)
{
  GtkWidget *label;
  const struct player *pplayer = client_player();
 
  label = gtk_frame_get_label_widget(GTK_FRAME(main_frame_civ_name));
  if (pplayer != NULL) {
    const gchar *name;
    gunichar c;
 
    /* Capitalize the first character of the translated nation
     * plural name so that the frame label looks good. */
    name = nation_plural_for_player(pplayer);
    c = g_utf8_get_char_validated(name, -1);
    if ((gunichar) -1 != c && (gunichar) -2 != c) {
      const char *obstext = NULL;
      int obstextlen = 0;
 
      if (client_is_observer()) {
        obstext = _(" (observer)");
        obstextlen = strlen(obstext);
      }
 
      {
        gchar nation[MAX_LEN_NAME + obstextlen];
        gchar *next;
        gint len;
 
        len = g_unichar_to_utf8(g_unichar_toupper(c), nation);
        nation[len] = '\0';
        next = g_utf8_find_next_char(name, NULL);
        if (NULL != next) {
          sz_strlcat(nation, next);
        }
        if (obstext != NULL) {
          sz_strlcat(nation, obstext);
        }
        gtk_label_set_text(GTK_LABEL(label), nation);
      }
    } else {
      gtk_label_set_text(GTK_LABEL(label), name);
    }
  } else {
    gtk_label_set_text(GTK_LABEL(label), "-");
  }
 
  gtk_label_set_text(GTK_LABEL(main_label_info),
                     get_info_label_text(!GUI_GTK_OPTION(small_display_layout)));
 
  set_indicator_icons(client_research_sprite(),
                      client_warming_sprite(),
                      client_cooling_sprite(),
                      client_government_sprite());
 
  if (NULL != pplayer) {
    int d = 0;
 
    for (; d < pplayer->economic.luxury / 10; d++) {
      struct sprite *spr = get_tax_sprite(tileset, O_LUXURY);
 
      gtk_image_set_from_surface(GTK_IMAGE(econ_label[d]), spr->surface);
    }
 
    for (; d < (pplayer->economic.science
                + pplayer->economic.luxury) / 10; d++) {
      struct sprite *spr = get_tax_sprite(tileset, O_SCIENCE);
 
      gtk_image_set_from_surface(GTK_IMAGE(econ_label[d]), spr->surface);
    }
 
    for (; d < 10; d++) {
      struct sprite *spr = get_tax_sprite(tileset, O_GOLD);
 
      gtk_image_set_from_surface(GTK_IMAGE(econ_label[d]), spr->surface);
    }
  }
 
  update_timeout_label();
 
  /* Update tooltips. */
  gtk_widget_set_tooltip_text(econ_ebox,
                              _("Shows your current luxury/science/tax rates; "
                                "click to toggle them."));
 
  gtk_widget_set_tooltip_text(bulb_ebox, get_bulb_tooltip());
  gtk_widget_set_tooltip_text(sun_ebox, get_global_warming_tooltip());
  gtk_widget_set_tooltip_text(flake_ebox, get_nuclear_winter_tooltip());
  gtk_widget_set_tooltip_text(government_ebox, get_government_tooltip());
}
 
/**********************************************************************/
static gboolean anim_cursor_cb(gpointer data)
{
  if (!cursor_timer_id) {
    return FALSE;
  }
 
  cursor_frame++;
  if (cursor_frame == NUM_CURSOR_FRAMES) {
    cursor_frame = 0;
  }
 
  if (cursor_type == CURSOR_DEFAULT) {
    gdk_window_set_cursor(root_window, NULL);
    cursor_timer_id = 0;
    return FALSE; 
  }
 
  gdk_window_set_cursor(root_window,
                fc_cursors[cursor_type][cursor_frame]);
  control_mouse_cursor(NULL);
  return TRUE;
}
 
/**********************************************************************/
void update_mouse_cursor(enum cursor_type new_cursor_type)
{
  cursor_type = new_cursor_type;
  if (!cursor_timer_id) {
    cursor_timer_id = g_timeout_add(CURSOR_INTERVAL, anim_cursor_cb, NULL);
  }
}
 
/**********************************************************************/
void update_unit_info_label(struct unit_list *punits)
{
  GtkWidget *label;
 
  label = gtk_frame_get_label_widget(GTK_FRAME(unit_info_frame));
  gtk_label_set_text(GTK_LABEL(label),
                     get_unit_info_label_text1(punits));
 
  gtk_label_set_text(GTK_LABEL(unit_info_label),
                     get_unit_info_label_text2(punits, 0));
 
  update_unit_pix_label(punits);
}
 
/**********************************************************************/
GdkPixbuf *get_thumb_pixbuf(int onoff)
{
  return sprite_get_pixbuf(get_treaty_thumb_sprite(tileset, BOOL_VAL(onoff)));
}
 
/**********************************************************************/
void set_indicator_icons(struct sprite *bulb, struct sprite *sol,
                         struct sprite *flake, struct sprite *gov)
{
  gtk_image_set_from_surface(GTK_IMAGE(bulb_label), bulb->surface);
  gtk_image_set_from_surface(GTK_IMAGE(sun_label), sol->surface);
  gtk_image_set_from_surface(GTK_IMAGE(flake_label), flake->surface);
  gtk_image_set_from_surface(GTK_IMAGE(government_label), gov->surface);
}
 
/**********************************************************************/
void get_overview_area_dimensions(int *width, int *height)
{
  *width = GUI_GTK_OVERVIEW_MIN_XSIZE;
  *height = GUI_GTK_OVERVIEW_MIN_YSIZE;
}
 
/**********************************************************************/
void overview_size_changed(void)
{
  gtk_widget_set_size_request(overview_canvas,
                              gui_options.overview.width,
                              gui_options.overview.height);
  update_map_canvas_scrollbars_size();
}
 
/**********************************************************************/
struct canvas *get_overview_window(void)
{
#if 0
  static struct canvas store;
 
  store.surface = NULL;
  store.drawable = gdk_cairo_create(gtk_widget_get_window(overview_canvas));
 
  return &store;
#endif /* 0 */
  if (can_client_change_view()) {
    gtk_widget_queue_draw(overview_canvas);
  }
  return NULL;
}
 
/**********************************************************************/
gboolean overview_canvas_draw(GtkWidget *w, cairo_t *cr, gpointer data)
{
  gpointer source = (can_client_change_view()) ?
                     (gpointer)gui_options.overview.window : NULL;
 
  if (source) {
    cairo_surface_t *surface = gui_options.overview.window->surface;
 
    cairo_set_source_surface(cr, surface, 0, 0);
    cairo_paint(cr);
  }
  return TRUE;
}
 
/**********************************************************************/
void mapview_freeze(void)
{
  mapview_frozen_level++;
}
 
/**********************************************************************/
void mapview_thaw(void)
{
  if (1 < mapview_frozen_level) {
    mapview_frozen_level--;
  } else {
    fc_assert(0 < mapview_frozen_level);
    mapview_frozen_level = 0;
    dirty_all();
  }
}
 
/**********************************************************************/
bool mapview_is_frozen(void)
{
  return (0 < mapview_frozen_level);
}
 
/**********************************************************************/
gboolean map_canvas_configure(GtkWidget *w, GdkEventConfigure *ev,
                              gpointer data)
{
  map_canvas_resized(ev->width, ev->height);
 
  return TRUE;
}
 
/**********************************************************************/
void map_canvas_size_refresh(void)
{
  /* Needed only with full screen zoom mode.
   * Not needed, nor implemented, in this client. */
  fc_assert(FALSE);
}
 
/**********************************************************************/
gboolean map_canvas_draw(GtkWidget *w, cairo_t *cr, gpointer data)
{
  if (can_client_change_view() && !map_is_empty() && !mapview_is_frozen()) {
    /* First we mark the area to be updated as dirty.  Then we unqueue
     * any pending updates, to make sure only the most up-to-date data
     * is written (otherwise drawing bugs happen when old data is copied
     * to screen).  Then we draw all changed areas to the screen. */
    update_animation();
    unqueue_mapview_updates(FALSE);
    cairo_set_source_surface(cr, mapview.store->surface, 0, 0);
    cairo_paint(cr);
  }
  return TRUE;
}
 
/**********************************************************************/
void dirty_rect(int canvas_x, int canvas_y,
                int pixel_width, int pixel_height)
{
  GdkRectangle rectangle = {canvas_x, canvas_y, pixel_width, pixel_height};
 
  if (gtk_widget_get_realized(map_canvas)) {
    gdk_window_invalidate_rect(gtk_widget_get_window(map_canvas), &rectangle, FALSE);
  }
}
 
/**********************************************************************/
void dirty_all(void)
{
  if (gtk_widget_get_realized(map_canvas)) {
    gdk_window_invalidate_rect(gtk_widget_get_window(map_canvas), NULL, FALSE);
  }
}
 
/**********************************************************************/
void flush_dirty(void)
{
  if (map_canvas != NULL && gtk_widget_get_realized(map_canvas)) {
    gdk_window_process_updates(gtk_widget_get_window(map_canvas), FALSE);
  }
}
 
/**********************************************************************/
void gui_flush(void)
{
  cairo_surface_flush(mapview.store->surface);
}
 
/**********************************************************************/
void update_city_descriptions(void)
{
  update_map_canvas_visible();
}
 
/**********************************************************************/
void put_unit_image(struct unit *punit, GtkImage *p, int height)
{
  struct canvas store = FC_STATIC_CANVAS_INIT;
  int width;
 
  if (height <= 0) {
    height = tileset_full_tile_height(tileset);
  }
  width = tileset_full_tile_width(tileset);
 
  store.surface = cairo_image_surface_create(CAIRO_FORMAT_ARGB32,
                                             width, height);
 
  put_unit(punit, &store, 1.0, 0, 0);
 
  gtk_image_set_from_surface(p, store.surface);
  cairo_surface_destroy(store.surface);
}
 
/**********************************************************************/
void put_unit_image_city_overlays(struct unit *punit, GtkImage *p,
                                  int height,
                                  int *upkeep_cost, int happy_cost)
{
  struct canvas store = FC_STATIC_CANVAS_INIT;
  int width = tileset_full_tile_width(tileset);
 
  store.surface = cairo_image_surface_create(CAIRO_FORMAT_ARGB32,
                                             width, height);
 
  put_unit(punit, &store, 1.0, 0, 0);
 
  put_unit_city_overlays(punit, &store, 0, tileset_unit_layout_offset_y(tileset),
                         upkeep_cost, happy_cost);
 
  gtk_image_set_from_surface(p, store.surface);
  cairo_surface_destroy(store.surface);
}
 
/**********************************************************************/
void pixmap_put_overlay_tile(GdkWindow *pixmap, float zoom,
                             int canvas_x, int canvas_y,
                             struct sprite *ssprite)
{
  cairo_t *cr;
  GdkDrawingContext *ctx;
 
  if (!ssprite) {
    return;
  }
 
  ctx = gdk_window_begin_draw_frame(pixmap,
                                    gdk_window_get_clip_region(pixmap));
  cr = gdk_drawing_context_get_cairo_context(ctx);
  cairo_scale(cr, zoom, zoom);
  cairo_set_source_surface(cr, ssprite->surface, canvas_x, canvas_y);
  cairo_paint(cr);
  gdk_window_end_draw_frame(pixmap, ctx);
}
 
/**********************************************************************/
void pixmap_put_overlay_tile_draw(struct canvas *pcanvas,
                                  int canvas_x, int canvas_y,
                                  struct sprite *ssprite,
                                  bool fog)
{
  cairo_t *cr;
  int sswidth, ssheight;
  const double bright = 0.65; /* Fogged brightness compared to unfogged */
 
  if (!ssprite) {
    return;
  }
 
  get_sprite_dimensions(ssprite, &sswidth, &ssheight);
 
  if (fog) {
    struct color *fogcol = color_alloc(0.0, 0.0, 0.0); /* black */
    cairo_surface_t *fog_surface;
    struct sprite *fogged;
    unsigned char *mask_in;
    unsigned char *mask_out;
    int i, j;
 
    /* Create sprites initially fully transparent */
    fogcol->color.alpha = 0.0;
    fogged = create_sprite(sswidth, ssheight, fogcol);
    fog_surface = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, sswidth, ssheight);
 
    /* Calculate black fog mask from the original sprite's alpha channel;
     * we don't want to blacken transparent parts of the sprite. */
    mask_in = cairo_image_surface_get_data(ssprite->surface);
    mask_out = cairo_image_surface_get_data(fog_surface);
 
    for (i = 0; i < sswidth; i++) {
      for (j = 0; j < ssheight; j++) {
        /* In order to darken pixels of ssprite to 'bright' fraction of
         * their original value, we need to overlay blackness of
         * (1-bright) transparency. */
        if (!is_bigendian()) {
          mask_out[(j * sswidth + i) * 4 + 3]
            = (1-bright) * mask_in[(j * sswidth + i) * 4 + 3];
        } else {
          mask_out[(j * sswidth + i) * 4 + 0]
            = (1-bright) * mask_in[(j * sswidth + i) * 4 + 0];
        }
      }
    }
 
    cairo_surface_mark_dirty(fog_surface);
 
    /* First copy original sprite canvas to intermediate sprite canvas */
    cr = cairo_create(fogged->surface);
    cairo_set_source_surface(cr, ssprite->surface, 0, 0);
    cairo_paint(cr);
 
    /* Then apply created fog to the intermediate sprite to darken it */
    cairo_set_source_surface(cr, fog_surface, 0, 0);
    cairo_paint(cr);
    cairo_destroy(cr);
 
    /* Put intermediate sprite to the target canvas */
    canvas_put_sprite(pcanvas, canvas_x, canvas_y,
                      fogged, 0, 0, sswidth, ssheight);
 
    /* Free intermediate stuff */
    cairo_surface_destroy(fog_surface);
    free_sprite(fogged);
    color_free(fogcol);
  } else {
    canvas_put_sprite(pcanvas, canvas_x, canvas_y,
                      ssprite, 0, 0, sswidth, ssheight);
  }
}
 
/**********************************************************************/
void put_cross_overlay_tile(struct tile *ptile)
{
  float canvas_x, canvas_y;
 
  if (tile_to_canvas_pos(&canvas_x, &canvas_y, map_zoom, ptile)) {
    pixmap_put_overlay_tile(gtk_widget_get_window(map_canvas), map_zoom,
                            canvas_x / map_zoom, canvas_y / map_zoom,
                            get_attention_crosshair_sprite(tileset));
  }
}
 
/**********************************************************************/
void update_overview_scroll_window_pos(int x, int y)
{
  gdouble ov_scroll_x, ov_scroll_y;
  GtkAdjustment *ov_hadj, *ov_vadj;
 
  ov_hadj = gtk_scrolled_window_get_hadjustment(
    GTK_SCROLLED_WINDOW(overview_scrolled_window));
  ov_vadj = gtk_scrolled_window_get_vadjustment(
    GTK_SCROLLED_WINDOW(overview_scrolled_window));
 
  ov_scroll_x = MIN(x - (overview_canvas_store_width / 2),
                    gtk_adjustment_get_upper(ov_hadj)
                    - gtk_adjustment_get_page_size(ov_hadj));
  ov_scroll_y = MIN(y - (overview_canvas_store_height / 2),
                    gtk_adjustment_get_upper(ov_vadj)
                    - gtk_adjustment_get_page_size(ov_vadj));
 
  gtk_adjustment_set_value(ov_hadj, ov_scroll_x);
  gtk_adjustment_set_value(ov_vadj, ov_scroll_y);
}
 
/**********************************************************************/
void update_map_canvas_scrollbars(void)
{
  int scroll_x, scroll_y;
 
  get_mapview_scroll_pos(&scroll_x, &scroll_y);
  gtk_adjustment_set_value(map_hadj, scroll_x);
  gtk_adjustment_set_value(map_vadj, scroll_y);
  if (can_client_change_view()) {
    gtk_widget_queue_draw(overview_canvas);
  }
}
 
/**********************************************************************/
void update_map_canvas_scrollbars_size(void)
{
  float xmin, ymin, xmax, ymax;
  int xsize, ysize, xstep, ystep;
 
  get_mapview_scroll_window(&xmin, &ymin, &xmax, &ymax, &xsize, &ysize);
  get_mapview_scroll_step(&xstep, &ystep);
 
  map_hadj = gtk_adjustment_new(-1, xmin, xmax, xstep, xsize, xsize);
  map_vadj = gtk_adjustment_new(-1, ymin, ymax, ystep, ysize, ysize);
 
  gtk_range_set_adjustment(GTK_RANGE(map_horizontal_scrollbar), map_hadj);
  gtk_range_set_adjustment(GTK_RANGE(map_vertical_scrollbar), map_vadj);
 
  g_signal_connect(map_hadj, "value_changed",
        G_CALLBACK(scrollbar_jump_callback),
        GINT_TO_POINTER(TRUE));
  g_signal_connect(map_vadj, "value_changed",
        G_CALLBACK(scrollbar_jump_callback),
        GINT_TO_POINTER(FALSE));
}
 
/**********************************************************************/
void scrollbar_jump_callback(GtkAdjustment *adj, gpointer hscrollbar)
{
  int scroll_x, scroll_y;
 
  if (!can_client_change_view()) {
    return;
  }
 
  get_mapview_scroll_pos(&scroll_x, &scroll_y);
 
  if (hscrollbar) {
    scroll_x = gtk_adjustment_get_value(adj);
  } else {
    scroll_y = gtk_adjustment_get_value(adj);
  }
 
  set_mapview_scroll_pos(scroll_x, scroll_y, mouse_zoom);
}
 
/**********************************************************************/
void draw_selection_rectangle(int canvas_x, int canvas_y, int w, int h)
{
  double dashes[2] = {4.0, 4.0};
  struct color *pcolor;
  cairo_t *cr;
  GdkDrawingContext *ctx;
  GdkWindow *wndw;
 
  if (w == 0 || h == 0) {
    return;
  }
 
  pcolor = get_color(tileset, COLOR_MAPVIEW_SELECTION);
  if (!pcolor) {
    return;
  }
 
  wndw = gtk_widget_get_window(map_canvas);
  ctx = gdk_window_begin_draw_frame(wndw,
                                    gdk_window_get_clip_region(wndw));
  cr = gdk_drawing_context_get_cairo_context(ctx);
  gdk_cairo_set_source_rgba(cr, &pcolor->color);
  cairo_set_line_width(cr, 2.0);
  cairo_set_dash(cr, dashes, 2, 0);
  cairo_set_operator(cr, CAIRO_OPERATOR_DIFFERENCE);
  cairo_rectangle(cr, canvas_x, canvas_y, w, h);
  cairo_stroke(cr);
  gdk_window_end_draw_frame(wndw, ctx);
}
 
/**********************************************************************/
void tileset_changed(void)
{
  science_report_dialog_redraw();
  reset_city_dialogs();
  reset_unit_table();
  blank_max_unit_size();
  editgui_tileset_changed();
 
  /* keep the icon of the executable on Windows (see PR#36491) */
#ifndef FREECIV_MSWINDOWS
  {
    GdkPixbuf *pixbuf = sprite_get_pixbuf(get_icon_sprite(tileset, ICON_FREECIV));
 
    /* Only call this after tileset_load_tiles is called. */
    gtk_window_set_icon(GTK_WINDOW(toplevel), pixbuf);
    g_object_unref(pixbuf);
  }
#endif /* FREECIV_MSWINDOWS */
}
 
/**********************************************************************/
void start_turn(void)
{}