gui_main.cpp

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
 
#ifdef AUDIO_SDL
/* Though it would happily compile without this include,
 * it is needed for sound to work.
 * It defines "main" macro to rename our main() so that
 * it can install SDL's own. */
#ifdef SDL2_PLAIN_INCLUDE
#include <SDL.h>
#else  // PLAIN_INCLUDE
#include <SDL2/SDL.h>
#endif // PLAIN_INCLUDE
#endif // AUDIO_SDL
 
#include <stdio.h>
 
// Qt
#include <QApplication>
#include <QLibraryInfo>
#include <QMessageBox>
#include <QScrollBar>
#include <QStyleFactory>
 
// utility
#include "fc_cmdline.h"
#include "fciconv.h"
#include "log.h"
 
// client
#include "client_main.h"
#include "editgui_g.h"
#include "gui_properties.h"
#include "options.h"
#include "sprite.h"
#include "svgflag.h"
#include "themes_common.h"
#include "tilespec.h"
 
// gui-qt
#include "fc_client.h"
#include "fonts.h"
#include "gui_main.h"
#include "helpdlg.h"
#include "hudwidget.h"
#include "qtg_cxxside.h"
 
extern void restart_notify_dialogs();
extern void city_font_update();
 
const bool gui_use_transliteration = false;
const char * const gui_character_encoding = "UTF-8";
const char *client_string = "gui-qt";
static fc_client *freeciv_qt;
static QApplication *qapp = nullptr;
 
void reset_unit_table(void);
static void apply_font(struct option *poption);
static void apply_help_font(struct option *poption);
static void apply_notify_font(struct option *poption);
static void apply_sidebar(struct option *poption);
static void apply_titlebar(struct option *poption);
static void apply_fullscreen(struct option *poption);
 
/**********************************************************************/
class fc_client *gui()
{
  return freeciv_qt;
}
 
/**********************************************************************/
void qtg_ui_init()
{}
 
/**********************************************************************/
int main(int argc, char **argv)
{
  setup_gui_funcs();
 
  return client_main(argc, argv, TRUE);
}
 
/**********************************************************************/
static void print_usage()
{
  // Add client-specific usage information here
  fc_fprintf(stderr,
             _("This client accepts the standard Qt command-line options\n"
               "after '--'. See the Qt documentation.\n\n"));
 
  fc_fprintf(stderr,
             _("Other gui-specific options are:\n"));
 
  fc_fprintf(stderr,
             _("-s, --shortcutreset\tReset shortcut keys to "
               "default values\n"));
 
  fc_fprintf(stderr, "\n");
 
  // TRANS: No full stop after the URL, could cause confusion.
  fc_fprintf(stderr, _("Report bugs at %s\n"), BUG_URL);
}
 
/**********************************************************************/
static bool parse_options(int argc, char **argv)
{
  int i = 1;
 
  while (i < argc) {
    if (is_option("--help", argv[i])) {
      print_usage();
      return false;
    }
    if (is_option("--shortcutreset", argv[i])) {
      shortcutreset();
    }
    // Can't check against unknown options, as those might be Qt options
 
    i++;
  }
 
  return true;
}
 
/**********************************************************************/
static void migrate_options_from_2_5()
{
  log_normal(_("Migrating Qt-client options from freeciv-2.5 options."));
 
  gui_options.gui_qt_fullscreen = gui_options.migrate_fullscreen;
 
  gui_options.gui_qt_migrated_from_2_5 = TRUE;
}
 
/**********************************************************************/
int qtg_ui_main(int argc, char *argv[])
{
  if (parse_options(argc, argv)) {
    qapp = new QApplication(argc, argv);
    QPixmap *qpm;
    QIcon app_icon;
    int tsret;
 
    tsret = default_tileset_select();
    if (tsret != EXIT_SUCCESS) {
      return tsret;
    }
 
    if (gui_options.gui_qt_svgflags) {
#ifdef FREECIV_SVG_FLAGS
      svg_flag_enable();
#else  // FREECIV_SVG_FLAGS
      fc_fprintf(stderr, _("svg flags not enabled in this freeciv build."));
#endif // FREECIV_SVG_FLAGS
    }
 
    tileset_init(tileset);
    tileset_load_tiles(tileset);
    qpm = get_icon_sprite(tileset, ICON_FREECIV)->pm;
    app_icon = ::QIcon(*qpm);
    qapp->setWindowIcon(app_icon);
    if (gui_options.first_boot) {
      /* We're using fresh defaults for this version of this client,
       * so prevent any future migrations from other versions */
      gui_options.gui_qt_migrated_from_2_5 = TRUE;
    } else if (!gui_options.gui_qt_migrated_from_2_5) {
      migrate_options_from_2_5();
    }
    if (!load_theme(gui_options.gui_qt_default_theme_name)) {
      qtg_gui_clear_theme();
    }
    freeciv_qt = new fc_client();
 
    if (!gui_options.gui_qt_default_fonts_set) {
      configure_fonts();
      gui_options.gui_qt_default_fonts_set = TRUE;
    }
 
    // Initial fonts setup by forcing running change-callback for each
    options_iterate(client_optset, poption) {
      if (OT_FONT == option_type(poption)) {
        option_changed(poption);
      }
    } options_iterate_end;
 
    freeciv_qt->fc_main(qapp);
  }
 
  return EXIT_SUCCESS;
}
 
/**********************************************************************/
QApplication *current_app()
{
  return qapp;
}
 
/**********************************************************************/
void qtg_options_extra_init()
{
    struct option *poption;
 
#define option_var_set_callback(var, callback)                              \
  if ((poption = optset_option_by_name(client_optset, #var))) {             \
    option_set_changed_callback(poption, callback);                         \
  } else {                                                                  \
    log_error("Didn't find option %s!", #var);                              \
  }
  option_var_set_callback(gui_qt_font_city_names,
                          apply_font);
  option_var_set_callback(gui_qt_font_city_productions,
                          apply_font);
  option_var_set_callback(gui_qt_font_reqtree_text,
                          apply_font);
  option_var_set_callback(gui_qt_font_default,
                          apply_font);
  option_var_set_callback(gui_qt_font_help_text,
                          apply_help_font);
  option_var_set_callback(gui_qt_font_chatline,
                          apply_font);
  option_var_set_callback(gui_qt_font_notify_label,
                          apply_notify_font);
  option_var_set_callback(gui_qt_show_titlebar,
                          apply_titlebar);
  option_var_set_callback(gui_qt_sidebar_left,
                          apply_sidebar);
  option_var_set_callback(gui_qt_fullscreen,
                          apply_fullscreen);
#undef option_var_set_callback
}
 
/**********************************************************************/
void qtg_ui_exit()
{
  delete freeciv_qt;
  delete qapp;
  qapp = nullptr;
}
 
/**********************************************************************/
void qtg_real_conn_list_dialog_update(void *unused)
{
  if (qtg_get_current_client_page() == PAGE_NETWORK) {
    qtg_real_set_client_page(PAGE_START);
  }
  gui()->update_start_page();
}
 
/**********************************************************************/
void qtg_sound_bell()
{
  QApplication::beep();
  QApplication::alert(gui()->central_wdg);
}
 
/**********************************************************************/
void qtg_add_net_input(int sock)
{
  gui()->add_server_source(sock);
}
 
/**********************************************************************/
void qtg_remove_net_input()
{
  gui()->remove_server_source();
}
 
/**********************************************************************/
void qtg_set_unit_icon(int idx, struct unit *punit)
{
  // PORTME
}
 
/**********************************************************************/
void qtg_set_unit_icons_more_arrow(bool onoff)
{
  // PORTME
}
 
/**********************************************************************/
void qtg_real_focus_units_changed(void)
{
  if (gui()->unit_sel != nullptr && gui()->unit_sel->isVisible()) {
    gui()->unit_sel->update_units();
  }
 
  if (gui()->gtd != nullptr && gui()->gtd->isVisible()) {
    gui()->gtd->update_dlg();
  }
}
 
/**********************************************************************/
void qtg_add_idle_callback(void (callback)(void *), void *data)
{
  call_me_back *cb = new call_me_back; // Removed in mr_idler:idling()
 
  cb->callback = callback;
  cb->data = data;
  gui()->mr_idler.add_callback(cb);
}
 
/**********************************************************************/
void apply_titlebar(struct option *poption)
{
  bool val;
  QWidget *w;
  Qt::WindowFlags flags = Qt::Window;
  val = option_bool_get(poption);
 
  if (gui()->current_page() < PAGE_GAME) {
    return;
  }
 
  if (val) {
    w = new QWidget();
    gui()->setWindowFlags(flags);
    delete gui()->corner_wid;
    gui()->corner_wid = nullptr;
    gui()->menu_bar->setCornerWidget(w);
  } else {
    flags |= Qt::CustomizeWindowHint;
    gui()->setWindowFlags(flags);
    gui()->corner_wid = new fc_corner(gui());
    gui()->menu_bar->setCornerWidget(gui()->corner_wid);
  }
  gui()->show();
}
 
/**********************************************************************/
void apply_sidebar(struct option *poption)
{
  gui()->update_sidebar_position();
}
 
/**********************************************************************/
static void apply_font(struct option *poption)
{
  QFont *f;
  QFont *remove_old;
  QString s;
 
  if (gui()) {
    // FIXME: All this should be within gui()->update_fonts()
    f = new QFont;
    s = option_font_get(poption);
    f->fromString(s);
    s = option_name(poption);
    remove_old = fc_font::instance()->get_font(s);
    delete remove_old;
    fc_font::instance()->set_font(s, f);
    update_city_descriptions();
    gui()->infotab->chtwdg->update_font();
    QApplication::setFont(*fc_font::instance()->get_font(fonts::default_font));
    qtg_real_science_report_dialog_update(nullptr);
    fc_font::instance()->get_mapfont_size();
    gui()->update_fonts();
  }
 
  apply_help_font(poption);
}
 
/**********************************************************************/
static void apply_help_font(struct option *poption)
{
  QFont *f;
  QFont *remove_old;
  QString s;
 
  if (gui()) {
    f = new QFont;
    s = option_font_get(poption);
    f->fromString(s);
    s = option_name(poption);
    remove_old = fc_font::instance()->get_font(s);
    delete remove_old;
    fc_font::instance()->set_font(s, f);
    update_help_fonts();
  }
}
 
/**********************************************************************/
static void apply_notify_font(struct option *poption)
{
  if (gui()) {
    qtg_gui_update_font("notify_label", option_font_get(poption));
    restart_notify_dialogs();
  }
  if (gui() && qtg_get_current_client_page() == PAGE_GAME) {
    qtg_gui_update_font("city_label", option_font_get(poption));
    city_font_update();
  }
}
 
/**********************************************************************/
static void apply_fullscreen(struct option *poption)
{
  gui()->apply_fullscreen();
}
 
/**********************************************************************/
void qtg_editgui_tileset_changed()
{}
 
/**********************************************************************/
void qtg_editgui_refresh()
{}
 
/**********************************************************************/
void qtg_editgui_popup_properties(const struct tile_list *tiles, int objtype)
{}
 
/**********************************************************************/
void qtg_editgui_popdown_all()
{}
 
/**********************************************************************/
void qtg_editgui_notify_object_changed(int objtype, int object_id,
                                       bool removal)
{}
 
/**********************************************************************/
void qtg_editgui_notify_object_created(int tag, int id)
{}
 
/**********************************************************************/
void qtg_gui_update_font(const char *font_name, const char *font_value)
{
  QFont *f;
  QFont *remove_old;
  QString fname;
 
  fname = "gui_qt_font_" + QString(font_name);
  f = new QFont;
  f->fromString(font_value);
  remove_old = fc_font::instance()->get_font(fname);
  delete remove_old;
  fc_font::instance()->set_font(fname, f);
  fc_font::instance()->get_mapfont_size();
}
 
/**********************************************************************/
enum gui_type qtg_get_gui_type()
{
  return GUI_QT;
}
 
/**********************************************************************/
void reset_unit_table(void)
{
  // FIXME
}
 
/**********************************************************************/
void popup_quit_dialog()
{
  hud_message_box *ask = new hud_message_box(gui()->central_wdg);
 
  ask->setStandardButtons(QMessageBox::Cancel | QMessageBox::Ok);
  ask->setDefaultButton(QMessageBox::Cancel);
  ask->set_text_title(_("Are you sure you want to quit?"),  _("Quit?"));
  ask->setAttribute(Qt::WA_DeleteOnClose);
  QObject::connect(ask, &hud_message_box::accepted, [=]() {
    start_quitting();
    if (client.conn.used) {
      disconnect_from_server(FALSE);
    }
    gui()->write_settings();
    qapp->quit();
  });
  ask->show();
}
 
/**********************************************************************/
void qtg_insert_client_build_info(char *outbuf, size_t outlen)
{
  // There's also an separate entry about Qt in help menu.
 
  QByteArray ver = QLibraryInfo::version().toString().toUtf8();
 
  cat_snprintf(outbuf, outlen, _("\nBuilt against Qt %s, using %s"),
               QT_VERSION_STR, ver.data());
 
#ifdef FC_QT5_MODE
  cat_snprintf(outbuf, outlen, _("\nBuilt in Qt5 mode."));
#elif defined(FC_QT6X_MODE)
  cat_snprintf(outbuf, outlen, _("\nBuilt in Qt6x mode."));
#else  // FC_QT5_MODE
  cat_snprintf(outbuf, outlen, _("\nBuilt in Qt6 mode."));
#endif // FC_QT5_MODE
}
 
/**********************************************************************/
void qtg_setup_gui_properties()
{
  gui_properties.animations = FALSE;
}