messagewin_common.c

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 2002 - R. Falke
   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 <string.h>
 
/* utility */
#include "fcintl.h"
#include "mem.h"
 
/* common */
#include "featured_text.h"
#include "map.h"
 
/* client/include */
#include "citydlg_g.h"
#include "mapview_g.h"
#include "messagewin_g.h"
 
/* client */
#include "client_main.h"
#include "options.h"
#include "update_queue.h"
 
#include "messagewin_common.h"
 
static struct message **messages = NULL;
static int messages_total = 0;
static int messages_alloc = 0;
 
/************************************************************************/
static void meswin_dialog_update(void)
{
  if (!can_client_change_view()) {
    return;
  }
 
  if (meswin_dialog_is_open()) {
    update_queue_add(real_meswin_dialog_update, NULL);
  } else if (0 < messages_total
             && (!client_has_player()
                 || is_human(client.conn.playing))) {
    meswin_dialog_popup(FALSE);
  }
}
 
/************************************************************************/
void meswin_clear_older(int turn, int phase)
{
  int i;
  int j = 0;
 
  if (!gui_options.show_previous_turn_messages) {
    turn = MESWIN_CLEAR_ALL;
  }
 
  for (i = 0;
       i < messages_total
       && (turn < 0
           || (messages[i]->turn < turn
               || (messages[i]->turn == turn && messages[i]->phase < phase))) ; i++) {
    free(messages[i]->descr);
 
    text_tag_list_destroy(messages[i]->tags);
    free(messages[i]);
    messages[i] = NULL;
  }
 
  if (i != 0) {
    for (; i < messages_total; i++, j++) {
      messages[j] = messages[i];
      messages[i] = NULL;
    }
    messages_total = j;
  }
 
  meswin_dialog_update();
}
 
/************************************************************************/
void meswin_add(const char *message, const struct text_tag_list *tags,
                struct tile *ptile, enum event_type event,
                int turn, int phase)
{
  const size_t min_msg_len = 50;
  size_t msg_len = strlen(message);
  char *s = fc_malloc(MAX(msg_len, min_msg_len) + 1);
  int i, nspc;
  struct message *msg;
 
  if (messages_total + 2 > messages_alloc) {
    messages_alloc = messages_total + 32;
    messages = fc_realloc(messages, messages_alloc * sizeof(struct message *));
  }
 
  msg = fc_malloc(sizeof(struct message));
  strcpy(s, message);
 
  nspc = min_msg_len - strlen(s);
  if (nspc > 0) {
    fc_strlcat(s, "                                                  ", min_msg_len);
  }
 
  msg->tile = ptile;
  msg->event = event;
  msg->descr = s;
  msg->tags = text_tag_list_copy(tags);
  msg->location_ok = (ptile != NULL);
  msg->visited = FALSE;
  msg->turn = turn;
  msg->phase = phase;
  messages[messages_total++] = msg;
 
  /* Update the city_ok fields of all messages since the city may have
   * changed owner. */
  for (i = 0; i < messages_total; i++) {
    if (messages[i]->location_ok) {
      struct city *pcity = tile_city(messages[i]->tile);
 
      messages[i]->city_ok =
          (pcity
           && (!client_has_player()
               || can_player_see_city_internals(client_player(), pcity)));
    } else {
      messages[i]->city_ok = FALSE;
    }
  }
 
  meswin_dialog_update();
}
 
/************************************************************************/
const struct message *meswin_get_message(int message_index)
{
  if (message_index >= 0 && message_index < messages_total) {
    return messages[message_index];
  } else {
    /* Can happen in turn change... */
    return NULL;
  }
}
 
/************************************************************************/
int meswin_get_num_messages(void)
{
  return messages_total;
}
 
/************************************************************************/
void meswin_set_visited_state(int message_index, bool state)
{
  fc_assert_ret(0 <= message_index && message_index < messages_total);
 
  messages[message_index]->visited = state;
}
 
/************************************************************************/
void meswin_popup_city(int message_index)
{
  fc_assert_ret(0 <= message_index && message_index < messages_total);
 
  if (messages[message_index]->city_ok) {
    struct tile *ptile = messages[message_index]->tile;
    struct city *pcity = tile_city(ptile);
 
    if (gui_options.center_when_popup_city) {
      center_tile_mapcanvas(ptile);
    }
 
    if (pcity && can_player_see_units_in_city(client.conn.playing, pcity)) {
      /* If the event was the city being destroyed, pcity will be NULL
       * and we'd better not try to pop it up.  It's also possible that
       * events will happen on enemy cities; we generally don't want to pop
       * those dialogs up either (although it's hard to be certain).
       *
       * In both cases, it would be better if the popup button weren't
       * highlighted at all - this is left up to the GUI. */
      popup_city_dialog(pcity);
    }
  }
}
 
/************************************************************************/
void meswin_goto(int message_index)
{
  fc_assert_ret(0 <= message_index && message_index < messages_total);
 
  if (messages[message_index]->location_ok) {
    center_tile_mapcanvas(messages[message_index]->tile);
  }
}
 
/************************************************************************/
void meswin_double_click(int message_index)
{
  fc_assert_ret(0 <= message_index && message_index < messages_total);
 
  if (messages[message_index]->city_ok
      && is_city_event(messages[message_index]->event)) {
    meswin_popup_city(message_index);
  } else if (messages[message_index]->location_ok) {
    meswin_goto(message_index);
  }
}