src/cmd-io/cmd-process-screen.cpp

   1 /*!
   2  * @brief 記念撮影のセーブとロード
   3  * @date 2020/04/22
   4  * @Author Hourier
   5  */
   6
   7 #include "cmd-io/cmd-process-screen.h"
   8 #include "cmd-visual/cmd-draw.h"
   9 #include "core/asking-player.h"
  10 #include "core/stuff-handler.h"
  11 #include "core/visuals-reseter.h"
  12 #include "game-option/special-options.h"
  13 #include "io/files-util.h"
  14 #include "io/input-key-acceptor.h"
  15 #include "system/angband-exceptions.h"
  16 #include "system/player-type-definition.h"
  17 #include "system/redrawing-flags-updater.h"
  18 #include "term/gameterm.h"
  19 #include "term/screen-processor.h"
  20 #include "term/term-color-types.h"
  21 #include "util/angband-files.h"
  22 #include "view/display-messages.h"
  23 #include <optional>
  24 #include <string>
  25 #include <string_view>
  26
  27 // Encode the screen colors
  28 static char hack[17] = "dwsorgbuDWvyRGBU";
  29
  30 static concptr tags[4] = {
  31     "HEADER_START:",
  32     "HEADER_END:",
  33     "FOOTER_START:",
  34     "FOOTER_END:",
  35 };
  36 static concptr html_head[3] = {
  37     "<html>\n<body text=\"#ffffff\" bgcolor=\"#000000\">\n",
  38     "<pre>",
  39     0,
  40 };
  41 static concptr html_foot[3] = {
  42     "</pre>\n",
  43     "</body>\n</html>\n",
  44     0,
  45 };
  46
  47 /*!
  48  * @brief 一時ファイルを読み込み、ファイルに書き出す
  49  * @param fff ファイルへの参照ポインタ
  50  * @param tempfff 一時ファイルへの参照ポインタ
  51  * @param num_tag タグ番号
  52  * @todo io/ 以下に移したいところだが、このファイルの行数も大したことがないので一旦保留
  53  */
  54 static void read_temporary_file(FILE *fff, FILE *tmpfff, int num_tag)
  55 {
  56     bool is_first_line = true;
  57     int next_tag = num_tag + 1;
  58     char buf[2048]{};
  59     while (!angband_fgets(tmpfff, buf, sizeof(buf))) {
  60         if (is_first_line) {
  61             if (strncmp(buf, tags[num_tag], strlen(tags[num_tag])) == 0) {
  62                 is_first_line = false;
  63             }
  64
  65             continue;
  66         }
  67
  68         if (strncmp(buf, tags[next_tag], strlen(tags[next_tag])) == 0) {
  69             break;
  70         }
  71
  72         fprintf(fff, "%s\n", buf);
  73     }
  74 }
  75
  76 /*!
  77  * @brief 記念撮影を1行ダンプする
  78  * @param wid 幅
  79  * @param y 現在の行位置
  80  * @param fff 記念撮影ファイルへの参照ポインタ
  81  */
  82 static void screen_dump_one_line(int wid, int y, FILE *fff)
  83 {
  84     TERM_COLOR a = 0, old_a = 0;
  85     char c = ' ';
  86     for (TERM_LEN x = 0; x < wid - 1; x++) {
  87         concptr cc = nullptr;
  88         (void)(term_what(x, y, &a, &c));
  89         switch (c) {
  90         case '&':
  91             cc = "&amp;";
  92             break;
  93         case '<':
  94             cc = "&lt;";
  95             break;
  96         case '>':
  97             cc = "&gt;";
  98             break;
  99 #ifdef WINDOWS
 100         case 0x1f:
 101             c = '.';
 102             break;
 103         case 0x7f:
 104             c = (a == 0x09) ? '%' : '#';
 105             break;
 106 #endif
 107         }
 108
 109         a = a & 0x0F;
 110         if ((y == 0 && x == 0) || a != old_a) {
 111             int rv = angband_color_table[a][1];
 112             int gv = angband_color_table[a][2];
 113             int bv = angband_color_table[a][3];
 114             fprintf(fff, "%s<font color=\"#%02x%02x%02x\">",
 115                 ((y == 0 && x == 0) ? "" : "</font>"), rv, gv, bv);
 116             old_a = a;
 117         }
 118
 119         if (cc) {
 120             fprintf(fff, "%s", cc);
 121         } else {
 122             fprintf(fff, "%c", c);
 123         }
 124     }
 125 }
 126
 127 /*!
 128  * @brief 記念撮影を行方向にスイープする
 129  * @param wid 幅
 130  * @param hgt 高さ
 131  * @param fff 記念撮影ファイルへの参照ポインタ
 132  */
 133 static void screen_dump_lines(int wid, int hgt, FILE *fff)
 134 {
 135     for (TERM_LEN y = 0; y < hgt; y++) {
 136         if (y != 0) {
 137             fprintf(fff, "\n");
 138         }
 139
 140         screen_dump_one_line(wid, y, fff);
 141     }
 142 }
 143
 144 /*!
 145  * @brief ファイルへ書き込めない場合にエラーを表示する
 146  * @param fff ダンプファイルへの参照ポインタ
 147  * @param path 保存先HTMLファイルのパス
 148  * @param need_message メッセージ表示の必要性
 149  * @return メッセージを表示して後続処理を実行するか否か
 150  */
 151 static bool check_screen_html_can_open(FILE *fff, const std::filesystem::path &path, bool need_message)
 152 {
 153     if (fff) {
 154         return true;
 155     }
 156
 157     if (!need_message) {
 158         return false;
 159     }
 160
 161     const auto &path_str = path.string();
 162     const auto mes = format(_("ファイル %s を開けませんでした。", "Failed to open file %s."), path_str.data());
 163     THROW_EXCEPTION(std::runtime_error, mes);
 164 }
 165
 166 /*!
 167  * @brief HTMLヘッダを書き込む
 168  * @param tmpfff 一時ファイルへの参照ポインタ
 169  * @param fff 記念撮影ファイルへの参照ポインタ
 170  */
 171 static void write_html_header(FILE *tmpfff, FILE *fff)
 172 {
 173     if (tmpfff) {
 174         read_temporary_file(fff, tmpfff, 0);
 175         return;
 176     }
 177
 178     for (int i = 0; html_head[i]; i++) {
 179         fputs(html_head[i], fff);
 180     }
 181 }
 182
 183 /*!
 184  * @brief HTMLフッタを書き込む
 185  * @param tmpfff 一時ファイルへの参照ポインタ
 186  * @param fff 記念撮影ファイルへの参照ポインタ
 187  */
 188 static void write_html_footer(FILE *tmpfff, FILE *fff)
 189 {
 190     fprintf(fff, "</font>");
 191     if (!tmpfff) {
 192         for (int i = 0; html_foot[i]; i++) {
 193             fputs(html_foot[i], fff);
 194         }
 195     } else {
 196         rewind(tmpfff);
 197         read_temporary_file(fff, tmpfff, 2);
 198         angband_fclose(tmpfff);
 199     }
 200
 201     fprintf(fff, "\n");
 202 }
 203
 204 void exe_cmd_save_screen_html(const std::filesystem::path &path, bool need_message)
 205 {
 206     const auto &[wid, hgt] = term_get_size();
 207     auto *fff = angband_fopen(path, FileOpenMode::WRITE, false, FileOpenType::HTML);
 208     if (!check_screen_html_can_open(fff, path, need_message)) {
 209         return;
 210     }
 211
 212     if (need_message) {
 213         screen_save();
 214     }
 215
 216     const auto &path_prf = path_build(ANGBAND_DIR_USER, "htmldump.prf");
 217     auto *tmpfff = angband_fopen(path_prf, FileOpenMode::READ);
 218     write_html_header(tmpfff, fff);
 219     screen_dump_lines(wid, hgt, fff);
 220     write_html_footer(tmpfff, fff);
 221     angband_fclose(fff);
 222     if (!need_message) {
 223         return;
 224     }
 225
 226     msg_print(_("画面(記念撮影)をファイルに書き出しました。", "Screen dump saved."));
 227     msg_print(nullptr);
 228     screen_load();
 229 }
 230
 231 /*!
 232  * @brief HTML方式で記念撮影する / Save a screen dump to a file
 233  * @param なし
 234  */
 235 static void exe_cmd_save_screen_html_with_naming()
 236 {
 237     const auto filename = input_string(_("ファイル名: ", "File name: "), 80, "screen.html");
 238     if (!filename) {
 239         return;
 240     }
 241
 242     auto path = path_build(ANGBAND_DIR_USER, *filename);
 243     msg_print(nullptr);
 244     exe_cmd_save_screen_html(path, true);
 245 }
 246
 247 /*!
 248  * @brief 記念撮影の方式を問い合わせる
 249  * @param html_dump HTMLダンプするか否か
 250  * @return ダンプするならTRUE、キャンセルならFALSE
 251  */
 252 static bool ask_html_dump(bool *html_dump)
 253 {
 254     while (true) {
 255         char c = inkey();
 256         if (c == 'Y' || c == 'y') {
 257             *html_dump = false;
 258             return true;
 259         }
 260
 261         if (c == 'H' || c == 'h') {
 262             *html_dump = true;
 263             return true;
 264         }
 265
 266         prt("", 0, 0);
 267         return false;
 268     }
 269
 270     // コンパイル警告対応.
 271     return false;
 272 }
 273
 274 /*!
 275  * @brief ファイルへ書き込めない場合にエラーを表示する
 276  * @param fff ダンプファイルへの参照ポインタ
 277  * @return ファイルへ書き込めるならTRUE、書き込めないならFALSE
 278  */
 279 static bool check_screen_text_can_open(FILE *fff, const std::string_view filename)
 280 {
 281     if (fff) {
 282         return true;
 283     }
 284
 285     msg_format(_("ファイル %s を開けませんでした。", "Failed to open file %s."), filename.data());
 286     msg_print(nullptr);
 287     return false;
 288 }
 289
 290 /*!
 291  * @brief テキスト方式で記念撮影する
 292  * @param wid 幅
 293  * @param hgt 高さ
 294  * @return 記念撮影に成功したらTRUE、ファイルが開けなかったらFALSE
 295  * @todo どこかバグっていて、(恐らく初期化されていない)変な文字列まで出力される
 296  */
 297 static bool do_cmd_save_screen_text(int wid, int hgt)
 298 {
 299     TERM_COLOR a = 0;
 300     auto c = ' ';
 301     const auto &path = path_build(ANGBAND_DIR_USER, "dump.txt");
 302     auto *fff = angband_fopen(path, FileOpenMode::WRITE);
 303     if (!check_screen_text_can_open(fff, path.string())) {
 304         return false;
 305     }
 306
 307     screen_save();
 308     for (TERM_LEN y = 0; y < hgt; y++) {
 309         TERM_LEN x;
 310         char buf[1024]{};
 311         for (x = 0; x < wid - 1; x++) {
 312             (void)(term_what(x, y, &a, &c));
 313             buf[x] = c;
 314         }
 315
 316         buf[x] = '\0';
 317         fprintf(fff, "%s\n", buf);
 318     }
 319
 320     fprintf(fff, "\n");
 321     for (TERM_LEN y = 0; y < hgt; y++) {
 322         TERM_LEN x;
 323         char buf[1024]{};
 324         for (x = 0; x < wid - 1; x++) {
 325             (void)(term_what(x, y, &a, &c));
 326             buf[x] = hack[a & 0x0F];
 327         }
 328
 329         buf[x] = '\0';
 330         fprintf(fff, "%s\n", buf);
 331     }
 332
 333     fprintf(fff, "\n");
 334     angband_fclose(fff);
 335     msg_print(_("画面(記念撮影)をファイルに書き出しました。", "Screen dump saved."));
 336     msg_print(nullptr);
 337     screen_load();
 338     return true;
 339 }
 340
 341 /*!
 342  * @brief 記念撮影のためにグラフィック使用をOFFにする
 343  * @param player_ptr プレイヤーへの参照ポインタ
 344  * @return 記念撮影直前のグラフィックオプション
 345  */
 346 static bool update_use_graphics(PlayerType *player_ptr)
 347 {
 348     if (!use_graphics) {
 349         return true;
 350     }
 351
 352     use_graphics = false;
 353     reset_visuals(player_ptr);
 354     static constexpr auto flags = {
 355         MainWindowRedrawingFlag::WIPE,
 356         MainWindowRedrawingFlag::BASIC,
 357         MainWindowRedrawingFlag::EXTRA,
 358         MainWindowRedrawingFlag::MAP,
 359         MainWindowRedrawingFlag::EQUIPPY,
 360     };
 361     RedrawingFlagsUpdater::get_instance().set_flags(flags);
 362     handle_stuff(player_ptr);
 363     return false;
 364 }
 365
 366 /*
 367  * Save a screen dump to a file
 368  * @param player_ptr プレイヤーへの参照ポインタ
 369  */
 370 void do_cmd_save_screen(PlayerType *player_ptr)
 371 {
 372     prt(_("記念撮影しますか？ [(y)es/(h)tml/(n)o] ", "Save screen dump? [(y)es/(h)tml/(n)o] "), 0, 0);
 373     bool html_dump;
 374     if (!ask_html_dump(&html_dump)) {
 375         return;
 376     }
 377
 378     const auto &[wid, hgt] = term_get_size();
 379     const auto old_use_graphics = update_use_graphics(player_ptr);
 380
 381     if (html_dump) {
 382         exe_cmd_save_screen_html_with_naming();
 383         do_cmd_redraw(player_ptr);
 384     } else if (!do_cmd_save_screen_text(wid, hgt)) {
 385         return;
 386     }
 387
 388     if (old_use_graphics) {
 389         return;
 390     }
 391
 392     use_graphics = true;
 393     reset_visuals(player_ptr);
 394     static constexpr auto flags = {
 395         MainWindowRedrawingFlag::WIPE,
 396         MainWindowRedrawingFlag::BASIC,
 397         MainWindowRedrawingFlag::EXTRA,
 398         MainWindowRedrawingFlag::MAP,
 399         MainWindowRedrawingFlag::EQUIPPY,
 400     };
 401     RedrawingFlagsUpdater::get_instance().set_flags(flags);
 402     handle_stuff(player_ptr);
 403 }
 404
 405 /*!
 406  * @brief 白文字だけ画面に描画する
 407  * @param buf 描画用バッファ
 408  * @param fff 記念撮影ファイルへの参照ポインタ
 409  * @param wid 幅
 410  * @param hgt 高さ
 411  * @todo 目的は不明瞭
 412  * @return ファイルが読み込めなくなったらFALSEで抜ける
 413  */
 414 static bool draw_white_characters(FILE *fff, int wid, int hgt)
 415 {
 416     bool okay = true;
 417     for (TERM_LEN y = 0; okay; y++) {
 418         char buf[1024]{};
 419         if (!fgets(buf, sizeof(buf), fff)) {
 420             okay = false;
 421         }
 422
 423         if (buf[0] == '\n' || buf[0] == '\0') {
 424             break;
 425         }
 426         if (y >= hgt) {
 427             continue;
 428         }
 429
 430         for (TERM_LEN x = 0; x < wid - 1; x++) {
 431             if (buf[x] == '\n' || buf[x] == '\0') {
 432                 break;
 433             }
 434
 435             term_draw(x, y, TERM_WHITE, buf[x]);
 436         }
 437     }
 438
 439     return okay;
 440 }
 441
 442 /*!
 443  * @brief 白以外の文字を画面に描画する
 444  * @param fff 記念撮影ファイルへの参照ポインタ
 445  * @param wid 幅
 446  * @param hgt 高さ
 447  * @param 白文字が途中で読み込めなくなっていたらTRUE
 448  * @todo 目的は不明瞭
 449  */
 450 static void draw_colored_characters(FILE *fff, int wid, int hgt, bool okay)
 451 {
 452     TERM_COLOR a = TERM_DARK;
 453     auto c = ' ';
 454     for (TERM_LEN y = 0; okay; y++) {
 455         char buf[1024]{};
 456         if (!fgets(buf, sizeof(buf), fff)) {
 457             okay = false;
 458         }
 459
 460         if (buf[0] == '\n' || buf[0] == '\0') {
 461             break;
 462         }
 463         if (y >= hgt) {
 464             continue;
 465         }
 466
 467         for (TERM_LEN x = 0; x < wid - 1; x++) {
 468             if (buf[x] == '\n' || buf[x] == '\0') {
 469                 break;
 470             }
 471
 472             (void)(term_what(x, y, &a, &c));
 473             for (int i = 0; i < 16; i++) {
 474                 if (hack[i] == buf[x]) {
 475                     a = (byte)i;
 476                 }
 477             }
 478
 479             term_draw(x, y, a, c);
 480         }
 481     }
 482 }
 483
 484 /*
 485  * @brief Load a screen dump from a file
 486  * @param なし
 487  */
 488 void do_cmd_load_screen(void)
 489 {
 490     const auto &[wid, hgt] = term_get_size();
 491     const auto path = path_build(ANGBAND_DIR_USER, "dump.txt");
 492     auto *fff = angband_fopen(path, FileOpenMode::READ);
 493     if (!fff) {
 494         const auto filename = path.string();
 495         msg_format(_("%s を開くことができませんでした。", "Failed to open %s."), filename.data());
 496         msg_print(nullptr);
 497         return;
 498     }
 499
 500     screen_save();
 501     term_clear();
 502     bool okay = draw_white_characters(fff, wid, hgt);
 503     draw_colored_characters(fff, wid, hgt, okay);
 504
 505     angband_fclose(fff);
 506     prt(_("ファイルに書き出された画面(記念撮影)をロードしました。", "Screen dump loaded."), 0, 0);
 507     flush();
 508     inkey();
 509     screen_load();
 510 }