src/save.c

   1 /* File: save.c */
   2
   3 /*
   4  * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke
   5  *
   6  * This software may be copied and distributed for educational, research,
   7  * and not for profit purposes provided that this copyright and statement
   8  * are included in all such copies.  Other copyrights may also apply.
   9  */
  10
  11 /* Purpose: interact with savefiles */
  12
  13 #include "angband.h"
  14
  15
  16
  17 /*
  18  * Some "local" parameters, used to help write savefiles
  19  */
  20
  21 static FILE     *fff;           /* Current save "file" */
  22
  23 static byte     xor_byte;       /* Simple encryption */
  24
  25 static u32b     v_stamp = 0L;   /* A simple "checksum" on the actual values */
  26 static u32b     x_stamp = 0L;   /* A simple "checksum" on the encoded bytes */
  27
  28
  29
  30 /*
  31  * These functions place information into a savefile a byte at a time
  32  */
  33
  34 static void sf_put(byte v)
  35 {
  36         /* Encode the value, write a character */
  37         xor_byte ^= v;
  38         (void)putc((int)xor_byte, fff);
  39
  40         /* Maintain the checksum info */
  41         v_stamp += v;
  42         x_stamp += xor_byte;
  43 }
  44
  45 static void wr_byte(byte v)
  46 {
  47         sf_put(v);
  48 }
  49
  50 static void wr_u16b(u16b v)
  51 {
  52         sf_put((byte)(v & 0xFF));
  53         sf_put((byte)((v >> 8) & 0xFF));
  54 }
  55
  56 static void wr_s16b(s16b v)
  57 {
  58         wr_u16b((u16b)v);
  59 }
  60
  61 static void wr_u32b(u32b v)
  62 {
  63         sf_put((byte)(v & 0xFF));
  64         sf_put((byte)((v >> 8) & 0xFF));
  65         sf_put((byte)((v >> 16) & 0xFF));
  66         sf_put((byte)((v >> 24) & 0xFF));
  67 }
  68
  69 static void wr_s32b(s32b v)
  70 {
  71         wr_u32b((u32b)v);
  72 }
  73
  74 static void wr_string(cptr str)
  75 {
  76         while (*str)
  77         {
  78                 wr_byte(*str);
  79                 str++;
  80         }
  81         wr_byte(*str);
  82 }
  83
  84
  85 /*
  86  * These functions write info in larger logical records
  87  */
  88
  89
  90 /*
  91  * Write an "item" record
  92  */
  93 static void wr_item(object_type *o_ptr)
  94 {
  95         u32b flags = 0x00000000;
  96
  97         if (o_ptr->pval) flags |= SAVE_ITEM_PVAL;
  98         if (o_ptr->discount) flags |= SAVE_ITEM_DISCOUNT;
  99         if (o_ptr->number != 1) flags |= SAVE_ITEM_NUMBER;
 100         if (o_ptr->name1) flags |= SAVE_ITEM_NAME1;
 101         if (o_ptr->name2) flags |= SAVE_ITEM_NAME2;
 102         if (o_ptr->timeout) flags |= SAVE_ITEM_TIMEOUT;
 103         if (o_ptr->to_h) flags |= SAVE_ITEM_TO_H;
 104         if (o_ptr->to_d) flags |= SAVE_ITEM_TO_D;
 105         if (o_ptr->to_a) flags |= SAVE_ITEM_TO_A;
 106         if (o_ptr->ac) flags |= SAVE_ITEM_AC;
 107         if (o_ptr->dd) flags |= SAVE_ITEM_DD;
 108         if (o_ptr->ds) flags |= SAVE_ITEM_DS;
 109         if (o_ptr->ident) flags |= SAVE_ITEM_IDENT;
 110         if (o_ptr->marked) flags |= SAVE_ITEM_MARKED;
 111         if (o_ptr->art_flags[0]) flags |= SAVE_ITEM_ART_FLAGS0;
 112         if (o_ptr->art_flags[1]) flags |= SAVE_ITEM_ART_FLAGS1;
 113         if (o_ptr->art_flags[2]) flags |= SAVE_ITEM_ART_FLAGS2;
 114         if (o_ptr->art_flags[3]) flags |= SAVE_ITEM_ART_FLAGS3;
 115         if (o_ptr->curse_flags) flags |= SAVE_ITEM_CURSE_FLAGS;
 116         if (o_ptr->held_m_idx) flags |= SAVE_ITEM_HELD_M_IDX;
 117         if (o_ptr->xtra1) flags |= SAVE_ITEM_XTRA1;
 118         if (o_ptr->xtra2) flags |= SAVE_ITEM_XTRA2;
 119         if (o_ptr->xtra3) flags |= SAVE_ITEM_XTRA3;
 120         if (o_ptr->xtra4) flags |= SAVE_ITEM_XTRA4;
 121         if (o_ptr->xtra5) flags |= SAVE_ITEM_XTRA5;
 122         if (o_ptr->feeling) flags |= SAVE_ITEM_FEELING;
 123         if (o_ptr->inscription) flags |= SAVE_ITEM_INSCRIPTION;
 124         if (o_ptr->art_name) flags |= SAVE_ITEM_ART_NAME;
 125
 126         /*** Item save flags ***/
 127         wr_u32b(flags);
 128
 129         /*** Write only un-obvious elements ***/
 130         wr_s16b(o_ptr->k_idx);
 131
 132         /* Location */
 133         wr_byte(o_ptr->iy);
 134         wr_byte(o_ptr->ix);
 135
 136         if (flags & SAVE_ITEM_PVAL) wr_s16b(o_ptr->pval);
 137
 138         if (flags & SAVE_ITEM_DISCOUNT) wr_byte(o_ptr->discount);
 139         if (flags & SAVE_ITEM_NUMBER) wr_byte(o_ptr->number);
 140
 141         wr_s16b(o_ptr->weight);
 142
 143         if (flags & SAVE_ITEM_NAME1) wr_byte(o_ptr->name1);
 144         if (flags & SAVE_ITEM_NAME2) wr_byte(o_ptr->name2);
 145         if (flags & SAVE_ITEM_TIMEOUT) wr_s16b(o_ptr->timeout);
 146
 147         if (flags & SAVE_ITEM_TO_H) wr_s16b(o_ptr->to_h);
 148         if (flags & SAVE_ITEM_TO_D) wr_s16b(o_ptr->to_d);
 149         if (flags & SAVE_ITEM_TO_A) wr_s16b(o_ptr->to_a);
 150         if (flags & SAVE_ITEM_AC) wr_s16b(o_ptr->ac);
 151         if (flags & SAVE_ITEM_DD) wr_byte(o_ptr->dd);
 152         if (flags & SAVE_ITEM_DS) wr_byte(o_ptr->ds);
 153
 154         if (flags & SAVE_ITEM_IDENT) wr_byte(o_ptr->ident);
 155
 156         if (flags & SAVE_ITEM_MARKED) wr_byte(o_ptr->marked);
 157
 158         if (flags & SAVE_ITEM_ART_FLAGS0) wr_u32b(o_ptr->art_flags[0]);
 159         if (flags & SAVE_ITEM_ART_FLAGS1) wr_u32b(o_ptr->art_flags[1]);
 160         if (flags & SAVE_ITEM_ART_FLAGS2) wr_u32b(o_ptr->art_flags[2]);
 161         if (flags & SAVE_ITEM_ART_FLAGS3) wr_u32b(o_ptr->art_flags[3]);
 162
 163         if (flags & SAVE_ITEM_CURSE_FLAGS) wr_u32b(o_ptr->curse_flags);
 164
 165         /* Held by monster index */
 166         if (flags & SAVE_ITEM_HELD_M_IDX) wr_s16b(o_ptr->held_m_idx);
 167
 168         /* Extra information */
 169         if (flags & SAVE_ITEM_XTRA1) wr_byte(o_ptr->xtra1);
 170         if (flags & SAVE_ITEM_XTRA2) wr_byte(o_ptr->xtra2);
 171         if (flags & SAVE_ITEM_XTRA3) wr_byte(o_ptr->xtra3);
 172         if (flags & SAVE_ITEM_XTRA4) wr_s16b(o_ptr->xtra4);
 173         if (flags & SAVE_ITEM_XTRA5) wr_s16b(o_ptr->xtra5);
 174
 175         /* Feelings */
 176         if (flags & SAVE_ITEM_FEELING) wr_byte(o_ptr->feeling);
 177
 178         if (flags & SAVE_ITEM_INSCRIPTION) wr_string(quark_str(o_ptr->inscription));
 179         if (flags & SAVE_ITEM_ART_NAME) wr_string(quark_str(o_ptr->art_name));
 180 }
 181
 182
 183 /*
 184  * Write a "monster" record
 185  */
 186 static void wr_monster(monster_type *m_ptr)
 187 {
 188         u32b flags = 0x00000000;
 189         byte tmp8u;
 190
 191         if (!is_original_ap(m_ptr)) flags |= SAVE_MON_AP_R_IDX;
 192         if (m_ptr->sub_align) flags |= SAVE_MON_SUB_ALIGN;
 193         if (MON_CSLEEP(m_ptr)) flags |= SAVE_MON_CSLEEP;
 194         if (MON_FAST(m_ptr)) flags |= SAVE_MON_FAST;
 195         if (MON_SLOW(m_ptr)) flags |= SAVE_MON_SLOW;
 196         if (MON_STUNNED(m_ptr)) flags |= SAVE_MON_STUNNED;
 197         if (MON_CONFUSED(m_ptr)) flags |= SAVE_MON_CONFUSED;
 198         if (MON_MONFEAR(m_ptr)) flags |= SAVE_MON_MONFEAR;
 199         if (m_ptr->target_y) flags |= SAVE_MON_TARGET_Y;
 200         if (m_ptr->target_x) flags |= SAVE_MON_TARGET_X;
 201         if (MON_INVULNER(m_ptr)) flags |= SAVE_MON_INVULNER;
 202         if (m_ptr->smart) flags |= SAVE_MON_SMART;
 203         if (m_ptr->exp) flags |= SAVE_MON_EXP;
 204         if (m_ptr->mflag2) flags |= SAVE_MON_MFLAG2;
 205         if (m_ptr->nickname) flags |= SAVE_MON_NICKNAME;
 206         if (m_ptr->parent_m_idx) flags |= SAVE_MON_PARENT;
 207
 208         /*** Monster save flags ***/
 209         wr_u32b(flags);
 210
 211         /*** Write only un-obvious elements ***/
 212         wr_s16b(m_ptr->r_idx);
 213         wr_byte(m_ptr->fy);
 214         wr_byte(m_ptr->fx);
 215         wr_s16b(m_ptr->hp);
 216         wr_s16b(m_ptr->maxhp);
 217         wr_s16b(m_ptr->max_maxhp);
 218         wr_u32b(m_ptr->dealt_damage);
 219
 220
 221         /* Monster race index of its appearance */
 222         if (flags & SAVE_MON_AP_R_IDX) wr_s16b(m_ptr->ap_r_idx);
 223
 224         if (flags & SAVE_MON_SUB_ALIGN) wr_byte(m_ptr->sub_align);
 225         if (flags & SAVE_MON_CSLEEP) wr_s16b(m_ptr->mtimed[MTIMED_CSLEEP]);
 226
 227         wr_byte(m_ptr->mspeed);
 228         wr_s16b(m_ptr->energy_need);
 229
 230         if (flags & SAVE_MON_FAST)
 231         {
 232                 tmp8u = (byte)m_ptr->mtimed[MTIMED_FAST];
 233                 wr_byte(tmp8u);
 234         }
 235         if (flags & SAVE_MON_SLOW)
 236         {
 237                 tmp8u = (byte)m_ptr->mtimed[MTIMED_SLOW];
 238                 wr_byte(tmp8u);
 239         }
 240         if (flags & SAVE_MON_STUNNED)
 241         {
 242                 tmp8u = (byte)m_ptr->mtimed[MTIMED_STUNNED];
 243                 wr_byte(tmp8u);
 244         }
 245         if (flags & SAVE_MON_CONFUSED)
 246         {
 247                 tmp8u = (byte)m_ptr->mtimed[MTIMED_CONFUSED];
 248                 wr_byte(tmp8u);
 249         }
 250         if (flags & SAVE_MON_MONFEAR)
 251         {
 252                 tmp8u = (byte)m_ptr->mtimed[MTIMED_MONFEAR];
 253                 wr_byte(tmp8u);
 254         }
 255         if (flags & SAVE_MON_TARGET_Y) wr_s16b(m_ptr->target_y);
 256         if (flags & SAVE_MON_TARGET_X) wr_s16b(m_ptr->target_x);
 257         if (flags & SAVE_MON_INVULNER)
 258         {
 259                 tmp8u = (byte)m_ptr->mtimed[MTIMED_INVULNER];
 260                 wr_byte(tmp8u);
 261         }
 262         if (flags & SAVE_MON_SMART) wr_u32b(m_ptr->smart);
 263         if (flags & SAVE_MON_EXP) wr_u32b(m_ptr->exp);
 264         if (flags & SAVE_MON_MFLAG2) wr_byte(m_ptr->mflag2);
 265         if (flags & SAVE_MON_NICKNAME) wr_string(quark_str(m_ptr->nickname));
 266         if (flags & SAVE_MON_PARENT) wr_s16b(m_ptr->parent_m_idx);
 267 }
 268
 269
 270 /*
 271  * Write a "lore" record
 272  */
 273 static void wr_lore(int r_idx)
 274 {
 275         monster_race *r_ptr = &r_info[r_idx];
 276
 277         /* Count sights/deaths/kills */
 278         wr_s16b(r_ptr->r_sights);
 279         wr_s16b(r_ptr->r_deaths);
 280         wr_s16b(r_ptr->r_pkills);
 281         wr_s16b(r_ptr->r_akills);
 282         wr_s16b(r_ptr->r_tkills);
 283
 284         /* Count wakes and ignores */
 285         wr_byte(r_ptr->r_wake);
 286         wr_byte(r_ptr->r_ignore);
 287
 288         /* Extra stuff */
 289         wr_byte(r_ptr->r_xtra1);
 290         wr_byte(r_ptr->r_xtra2);
 291
 292         /* Count drops */
 293         wr_byte(r_ptr->r_drop_gold);
 294         wr_byte(r_ptr->r_drop_item);
 295
 296         /* Count spells */
 297         wr_byte(0); /* unused now */
 298         wr_byte(r_ptr->r_cast_spell);
 299
 300         /* Count blows of each type */
 301         wr_byte(r_ptr->r_blows[0]);
 302         wr_byte(r_ptr->r_blows[1]);
 303         wr_byte(r_ptr->r_blows[2]);
 304         wr_byte(r_ptr->r_blows[3]);
 305
 306         /* Memorize flags */
 307         wr_u32b(r_ptr->r_flags1);
 308         wr_u32b(r_ptr->r_flags2);
 309         wr_u32b(r_ptr->r_flags3);
 310         wr_u32b(r_ptr->r_flags4);
 311         wr_u32b(r_ptr->r_flags5);
 312         wr_u32b(r_ptr->r_flags6);
 313         wr_u32b(r_ptr->r_flagsr);
 314
 315
 316         /* Monster limit per level */
 317         wr_byte(r_ptr->max_num);
 318
 319         /* Location in saved floor */
 320         wr_s16b(r_ptr->floor_id);
 321
 322         /* Later (?) */
 323         wr_byte(0);
 324 }
 325
 326
 327 /*
 328  * Write an "xtra" record
 329  */
 330 static void wr_xtra(int k_idx)
 331 {
 332         byte tmp8u = 0;
 333
 334         object_kind *k_ptr = &k_info[k_idx];
 335
 336         if (k_ptr->aware) tmp8u |= 0x01;
 337         if (k_ptr->tried) tmp8u |= 0x02;
 338
 339         wr_byte(tmp8u);
 340 }
 341
 342
 343 /*
 344  * Write a "store" record
 345  */
 346 static void wr_store(store_type *st_ptr)
 347 {
 348         int j;
 349
 350         /* Save the "open" counter */
 351         wr_u32b(st_ptr->store_open);
 352
 353         /* Save the "insults" */
 354         wr_s16b(st_ptr->insult_cur);
 355
 356         /* Save the current owner */
 357         wr_byte(st_ptr->owner);
 358
 359         /* Save the stock size */
 360         wr_s16b(st_ptr->stock_num);
 361
 362         /* Save the "haggle" info */
 363         wr_s16b(st_ptr->good_buy);
 364         wr_s16b(st_ptr->bad_buy);
 365
 366         wr_s32b(st_ptr->last_visit);
 367
 368         /* Save the stock */
 369         for (j = 0; j < st_ptr->stock_num; j++)
 370         {
 371                 /* Save each item in stock */
 372                 wr_item(&st_ptr->stock[j]);
 373         }
 374 }
 375
 376
 377 /*
 378  * Write RNG state
 379  */
 380 static errr wr_randomizer(void)
 381 {
 382         int i;
 383
 384         /* Zero */
 385         wr_u16b(0);
 386
 387         /* Place */
 388         wr_u16b(Rand_place);
 389
 390         /* State */
 391         for (i = 0; i < RAND_DEG; i++)
 392         {
 393                 wr_u32b(Rand_state[i]);
 394         }
 395
 396         /* Success */
 397         return (0);
 398 }
 399
 400
 401 /*
 402  * Write the "options"
 403  */
 404 static void wr_options(void)
 405 {
 406         int i;
 407
 408         u16b c;
 409
 410
 411         /*** Oops ***/
 412
 413         /* Oops */
 414         for (i = 0; i < 4; i++) wr_u32b(0L);
 415
 416
 417         /*** Special Options ***/
 418
 419         /* Write "delay_factor" */
 420         wr_byte(delay_factor);
 421
 422         /* Write "hitpoint_warn" */
 423         wr_byte(hitpoint_warn);
 424
 425         /* Write "mana_warn" */
 426         wr_byte(mana_warn);
 427
 428         /*** Cheating options ***/
 429
 430         c = 0;
 431
 432         if (p_ptr->wizard) c |= 0x0002;
 433
 434         if (cheat_peek) c |= 0x0100;
 435         if (cheat_hear) c |= 0x0200;
 436         if (cheat_room) c |= 0x0400;
 437         if (cheat_xtra) c |= 0x0800;
 438         if (cheat_know) c |= 0x1000;
 439         if (cheat_live) c |= 0x2000;
 440         if (cheat_save) c |= 0x4000;
 441
 442         wr_u16b(c);
 443
 444         /* Autosave info */
 445         wr_byte(autosave_l);
 446         wr_byte(autosave_t);
 447         wr_s16b(autosave_freq);
 448
 449         /*** Extract options ***/
 450
 451         /* Analyze the options */
 452         for (i = 0; option_info[i].o_desc; i++)
 453         {
 454                 int os = option_info[i].o_set;
 455                 int ob = option_info[i].o_bit;
 456
 457                 /* Process real entries */
 458                 if (option_info[i].o_var)
 459                 {
 460                         /* Set */
 461                         if (*option_info[i].o_var)
 462                         {
 463                                 /* Set */
 464                                 option_flag[os] |= (1L << ob);
 465                         }
 466
 467                         /* Clear */
 468                         else
 469                         {
 470                                 /* Clear */
 471                                 option_flag[os] &= ~(1L << ob);
 472                         }
 473                 }
 474         }
 475
 476
 477         /*** Normal options ***/
 478
 479         /* Dump the flags */
 480         for (i = 0; i < 8; i++) wr_u32b(option_flag[i]);
 481
 482         /* Dump the masks */
 483         for (i = 0; i < 8; i++) wr_u32b(option_mask[i]);
 484
 485
 486         /*** Window options ***/
 487
 488         /* Dump the flags */
 489         for (i = 0; i < 8; i++) wr_u32b(window_flag[i]);
 490
 491         /* Dump the masks */
 492         for (i = 0; i < 8; i++) wr_u32b(window_mask[i]);
 493 }
 494
 495
 496 /*
 497  * Hack -- Write the "ghost" info
 498  */
 499 static void wr_ghost(void)
 500 {
 501         int i;
 502
 503         /* Name */
 504 #ifdef JP
 505         wr_string("ÉÔÀµ¤Ê¥´¡¼¥¹¥È");
 506 #else
 507         wr_string("Broken Ghost");
 508 #endif
 509
 510
 511         /* Hack -- stupid data */
 512         for (i = 0; i < 60; i++) wr_byte(0);
 513 }
 514
 515
 516 /*
 517  * Save quick start data
 518  */
 519 static void save_quick_start(void)
 520 {
 521         int i;
 522
 523         wr_byte(previous_char.psex);
 524         wr_byte(previous_char.prace);
 525         wr_byte(previous_char.pclass);
 526         wr_byte(previous_char.pseikaku);
 527         wr_byte(previous_char.realm1);
 528         wr_byte(previous_char.realm2);
 529
 530         wr_s16b(previous_char.age);
 531         wr_s16b(previous_char.ht);
 532         wr_s16b(previous_char.wt);
 533         wr_s16b(previous_char.sc);
 534         wr_s32b(previous_char.au);
 535
 536         for (i = 0; i < 6; i++) wr_s16b(previous_char.stat_max[i]);
 537         for (i = 0; i < 6; i++) wr_s16b(previous_char.stat_max_max[i]);
 538
 539         for (i = 0; i < PY_MAX_LEVEL; i++) wr_s16b(previous_char.player_hp[i]);
 540
 541         wr_s16b(previous_char.chaos_patron);
 542
 543         for (i = 0; i < 8; i++) wr_s16b(previous_char.vir_types[i]);
 544
 545         for (i = 0; i < 4; i++) wr_string(previous_char.history[i]);
 546
 547         /* UNUSED : Was number of random quests */
 548         wr_byte(0);
 549
 550         /* No quick start after using debug mode or cheat options */
 551         if (p_ptr->noscore) previous_char.quick_ok = FALSE;
 552
 553         wr_byte((byte)previous_char.quick_ok);
 554 }
 555
 556 /*
 557  * Write some "extra" info
 558  */
 559 static void wr_extra(void)
 560 {
 561         int i,j;
 562         byte tmp8u;
 563
 564         wr_string(player_name);
 565
 566         wr_string(p_ptr->died_from);
 567
 568         wr_string(p_ptr->last_message ? p_ptr->last_message : "");
 569
 570         save_quick_start();
 571
 572         for (i = 0; i < 4; i++)
 573         {
 574                 wr_string(p_ptr->history[i]);
 575         }
 576
 577         /* Race/Class/Gender/Spells */
 578         wr_byte(p_ptr->prace);
 579         wr_byte(p_ptr->pclass);
 580         wr_byte(p_ptr->pseikaku);
 581         wr_byte(p_ptr->psex);
 582         wr_byte(p_ptr->realm1);
 583         wr_byte(p_ptr->realm2);
 584         wr_byte(0);     /* oops */
 585
 586         wr_byte(p_ptr->hitdie);
 587         wr_u16b(p_ptr->expfact);
 588
 589         wr_s16b(p_ptr->age);
 590         wr_s16b(p_ptr->ht);
 591         wr_s16b(p_ptr->wt);
 592
 593         /* Dump the stats (maximum and current) */
 594         for (i = 0; i < 6; ++i) wr_s16b(p_ptr->stat_max[i]);
 595         for (i = 0; i < 6; ++i) wr_s16b(p_ptr->stat_max_max[i]);
 596         for (i = 0; i < 6; ++i) wr_s16b(p_ptr->stat_cur[i]);
 597
 598         /* Ignore the transient stats */
 599         for (i = 0; i < 12; ++i) wr_s16b(0);
 600
 601         wr_u32b(p_ptr->au);
 602
 603         wr_u32b(p_ptr->max_exp);
 604         wr_u32b(p_ptr->max_max_exp);
 605         wr_u32b(p_ptr->exp);
 606         wr_u32b(p_ptr->exp_frac);
 607         wr_s16b(p_ptr->lev);
 608
 609         for (i = 0; i < 64; i++) wr_s16b(p_ptr->spell_exp[i]);
 610         for (i = 0; i < 5; i++) for (j = 0; j < 64; j++) wr_s16b(p_ptr->weapon_exp[i][j]);
 611         for (i = 0; i < 10; i++) wr_s16b(p_ptr->skill_exp[i]);
 612         for (i = 0; i < 108; i++) wr_s32b(p_ptr->magic_num1[i]);
 613         for (i = 0; i < 108; i++) wr_byte(p_ptr->magic_num2[i]);
 614
 615         wr_byte(p_ptr->start_race);
 616         wr_s32b(p_ptr->old_race1);
 617         wr_s32b(p_ptr->old_race2);
 618         wr_s16b(p_ptr->old_realm);
 619
 620         for (i = 0; i < MAX_MANE; i++)
 621         {
 622                 wr_s16b(p_ptr->mane_spell[i]);
 623                 wr_s16b(p_ptr->mane_dam[i]);
 624         }
 625         wr_s16b(p_ptr->mane_num);
 626
 627         for (i = 0; i < MAX_KUBI; i++)
 628         {
 629                 wr_s16b(kubi_r_idx[i]);
 630         }
 631
 632         for (i = 0; i < 4; i++)
 633         {
 634                 wr_s16b(battle_mon[i]);
 635                 wr_u32b(mon_odds[i]);
 636         }
 637
 638         wr_s16b(p_ptr->town_num); /* -KMW- */
 639
 640         /* Write arena and rewards information -KMW- */
 641         wr_s16b(p_ptr->arena_number);
 642         wr_s16b(p_ptr->inside_arena);
 643         wr_s16b(p_ptr->inside_quest);
 644         wr_s16b(p_ptr->inside_battle);
 645         wr_byte(p_ptr->exit_bldg);
 646         wr_byte(0); /* Unused */
 647
 648         wr_s16b(p_ptr->oldpx);
 649         wr_s16b(p_ptr->oldpy);
 650
 651         /* Was number of p_ptr->rewards[] */
 652         wr_s16b(0);
 653
 654         wr_s32b(p_ptr->mhp);
 655         wr_s32b(p_ptr->chp);
 656         wr_u32b(p_ptr->chp_frac);
 657
 658         wr_s32b(p_ptr->msp);
 659         wr_s32b(p_ptr->csp);
 660         wr_u32b(p_ptr->csp_frac);
 661
 662         /* Max Player and Dungeon Levels */
 663         wr_s16b(p_ptr->max_plv);
 664         tmp8u = (byte)max_d_idx;
 665         wr_byte(tmp8u);
 666         for (i = 0; i < tmp8u; i++)
 667                 wr_s16b(max_dlv[i]);
 668
 669         /* More info */
 670         wr_s16b(0);     /* oops */
 671         wr_s16b(0);     /* oops */
 672         wr_s16b(0);     /* oops */
 673         wr_s16b(0);     /* oops */
 674         wr_s16b(p_ptr->sc);
 675         wr_s16b(p_ptr->concent);
 676
 677         wr_s16b(0);             /* old "rest" */
 678         wr_s16b(p_ptr->blind);
 679         wr_s16b(p_ptr->paralyzed);
 680         wr_s16b(p_ptr->confused);
 681         wr_s16b(p_ptr->food);
 682         wr_s16b(0);     /* old "food_digested" */
 683         wr_s16b(0);     /* old "protection" */
 684         wr_s16b(p_ptr->energy_need);
 685         wr_s16b(p_ptr->enchant_energy_need);
 686         wr_s16b(p_ptr->fast);
 687         wr_s16b(p_ptr->slow);
 688         wr_s16b(p_ptr->afraid);
 689         wr_s16b(p_ptr->cut);
 690         wr_s16b(p_ptr->stun);
 691         wr_s16b(p_ptr->poisoned);
 692         wr_s16b(p_ptr->image);
 693         wr_s16b(p_ptr->protevil);
 694         wr_s16b(p_ptr->invuln);
 695         wr_s16b(p_ptr->ult_res);
 696         wr_s16b(p_ptr->hero);
 697         wr_s16b(p_ptr->shero);
 698         wr_s16b(p_ptr->shield);
 699         wr_s16b(p_ptr->blessed);
 700         wr_s16b(p_ptr->tim_invis);
 701         wr_s16b(p_ptr->word_recall);
 702         wr_s16b(p_ptr->recall_dungeon);
 703         wr_s16b(p_ptr->alter_reality);
 704         wr_s16b(p_ptr->see_infra);
 705         wr_s16b(p_ptr->tim_infra);
 706         wr_s16b(p_ptr->oppose_fire);
 707         wr_s16b(p_ptr->oppose_cold);
 708         wr_s16b(p_ptr->oppose_acid);
 709         wr_s16b(p_ptr->oppose_elec);
 710         wr_s16b(p_ptr->oppose_pois);
 711         wr_s16b(p_ptr->tsuyoshi);
 712         wr_s16b(p_ptr->tim_esp);
 713         wr_s16b(p_ptr->wraith_form);
 714         wr_s16b(p_ptr->resist_magic);
 715         wr_s16b(p_ptr->tim_regen);
 716         wr_s16b(p_ptr->kabenuke);
 717         wr_s16b(p_ptr->tim_stealth);
 718         wr_s16b(p_ptr->tim_levitation);
 719         wr_s16b(p_ptr->tim_sh_touki);
 720         wr_s16b(p_ptr->lightspeed);
 721         wr_s16b(p_ptr->tsubureru);
 722         wr_s16b(p_ptr->magicdef);
 723         wr_s16b(p_ptr->tim_res_nether);
 724         wr_s16b(p_ptr->tim_res_time);
 725         wr_byte(p_ptr->mimic_form);
 726         wr_s16b(p_ptr->tim_mimic);
 727         wr_s16b(p_ptr->tim_sh_fire);
 728         wr_s16b(p_ptr->tim_sh_holy);
 729         wr_s16b(p_ptr->tim_eyeeye);
 730
 731         /* by henkma */
 732         wr_s16b(p_ptr->tim_reflect);
 733         wr_s16b(p_ptr->multishadow);
 734         wr_s16b(p_ptr->dustrobe);
 735
 736         wr_s16b(p_ptr->chaos_patron);
 737         wr_u32b(p_ptr->muta1);
 738         wr_u32b(p_ptr->muta2);
 739         wr_u32b(p_ptr->muta3);
 740
 741         for (i = 0; i<8; i++)
 742                 wr_s16b(p_ptr->virtues[i]);
 743         for (i = 0; i<8; i++)
 744                 wr_s16b(p_ptr->vir_types[i]);
 745
 746         wr_s16b(p_ptr->ele_attack);
 747         wr_u32b(p_ptr->special_attack);
 748         wr_s16b(p_ptr->ele_immune);
 749         wr_u32b(p_ptr->special_defense);
 750         wr_byte(p_ptr->knowledge);
 751         wr_byte(p_ptr->autopick_autoregister);
 752         wr_byte(0);     /* oops */
 753         wr_byte(p_ptr->action);
 754         wr_byte(0);
 755         wr_byte(preserve_mode);
 756         wr_byte(p_ptr->wait_report_score);
 757
 758         /* Future use */
 759         for (i = 0; i < 12; i++) wr_u32b(0L);
 760
 761         /* Ignore some flags */
 762         wr_u32b(0L);    /* oops */
 763         wr_u32b(0L);    /* oops */
 764         wr_u32b(0L);    /* oops */
 765
 766
 767         /* Write the "object seeds" */
 768         wr_u32b(seed_flavor);
 769         wr_u32b(seed_town);
 770
 771
 772         /* Special stuff */
 773         wr_u16b(p_ptr->panic_save);
 774         wr_u16b(p_ptr->total_winner);
 775         wr_u16b(p_ptr->noscore);
 776
 777
 778         /* Write death */
 779         wr_byte(p_ptr->is_dead);
 780
 781         /* Write feeling */
 782         wr_byte(p_ptr->feeling);
 783
 784         /* Turn when level began */
 785         wr_s32b(old_turn);
 786
 787         /* Turn of last "feeling" */
 788         wr_s32b(p_ptr->feeling_turn);
 789
 790         /* Current turn */
 791         wr_s32b(turn);
 792
 793         wr_s32b(dungeon_turn);
 794
 795         wr_s32b(old_battle);
 796
 797         wr_s16b(today_mon);
 798         wr_s16b(p_ptr->today_mon);
 799         wr_s16b(p_ptr->riding);
 800
 801         /* Current floor_id */
 802         wr_s16b(p_ptr->floor_id);
 803
 804         /* Save temporary preserved pets (obsolated) */
 805         wr_s16b(0);
 806
 807         wr_u32b(playtime);
 808
 809         wr_s32b(p_ptr->visit);
 810
 811         wr_u32b(p_ptr->count);
 812 }
 813
 814
 815
 816 /*
 817  * hook function to sort monsters by level
 818  */
 819 static bool ang_sort_comp_cave_temp(vptr u, vptr v, int a, int b)
 820 {
 821         cave_template_type *who = (cave_template_type *)(u);
 822
 823         u16b o1 = who[a].occurrence;
 824         u16b o2 = who[b].occurrence;
 825
 826         /* Unused */
 827         (void)v;
 828
 829         return o2 <= o1;
 830 }
 831
 832
 833 /*
 834  * Sorting hook -- Swap function
 835  */
 836 static void ang_sort_swap_cave_temp(vptr u, vptr v, int a, int b)
 837 {
 838         cave_template_type *who = (cave_template_type *)(u);
 839
 840         cave_template_type holder;
 841
 842         /* Unused */
 843         (void)v;
 844
 845         /* Swap */
 846         holder = who[a];
 847         who[a] = who[b];
 848         who[b] = holder;
 849 }
 850
 851
 852 /*
 853  * Actually write a saved floor data
 854  * using effectively compressed format.
 855  */
 856 static void wr_saved_floor(saved_floor_type *sf_ptr)
 857 {
 858         cave_template_type *templates;
 859         u16b max_num_temp;
 860         u16b num_temp = 0;
 861         int dummy_why;
 862
 863         int i, y, x;
 864
 865         u16b tmp16u;
 866
 867         byte count;
 868         u16b prev_u16b;
 869
 870
 871         /*** Basic info ***/
 872
 873         /* Dungeon floor specific info follows */
 874
 875         if (!sf_ptr)
 876         {
 877                 /*** Not a saved floor ***/
 878
 879                 wr_s16b(dun_level);
 880         }
 881         else
 882         {
 883                 /*** The saved floor ***/
 884
 885                 wr_s16b(sf_ptr->floor_id);
 886                 wr_byte(sf_ptr->savefile_id);
 887                 wr_s16b(sf_ptr->dun_level);
 888                 wr_s32b(sf_ptr->last_visit);
 889                 wr_u32b(sf_ptr->visit_mark);
 890                 wr_s16b(sf_ptr->upper_floor_id);
 891                 wr_s16b(sf_ptr->lower_floor_id);
 892         }
 893
 894         wr_u16b(base_level);
 895         wr_u16b(num_repro);
 896         wr_u16b((u16b)py);
 897         wr_u16b((u16b)px);
 898         wr_u16b(cur_hgt);
 899         wr_u16b(cur_wid);
 900         wr_byte(p_ptr->feeling);
 901
 902
 903
 904         /*********** Make template for cave_type **********/
 905
 906         /*
 907          * Usually number of templates are fewer than 255.  Even if
 908          * more than 254 are exist, the occurrence of each template
 909          * with larger ID is very small when we sort templates by
 910          * occurrence.  So we will use two (or more) bytes for
 911          * templete ID larger than 254.
 912          *
 913          * Ex: 256 will be "0xff" "0x01".
 914          *     515 will be "0xff" "0xff" "0x03"
 915          */
 916
 917         /* Fake max number */
 918         max_num_temp = 255;
 919
 920         /* Allocate the "template" array */
 921         C_MAKE(templates, max_num_temp, cave_template_type);
 922
 923         /* Extract template array */
 924         for (y = 0; y < cur_hgt; y++)
 925         {
 926                 for (x = 0; x < cur_wid; x++)
 927                 {
 928                         cave_type *c_ptr = &cave[y][x];
 929
 930                         for (i = 0; i < num_temp; i++)
 931                         {
 932                                 if (templates[i].info == c_ptr->info &&
 933                                     templates[i].feat == c_ptr->feat &&
 934                                     templates[i].mimic == c_ptr->mimic &&
 935                                     templates[i].special == c_ptr->special)
 936                                 {
 937                                         /* Same terrain is exist */
 938                                         templates[i].occurrence++;
 939                                         break;
 940                                 }
 941                         }
 942
 943                         /* Are there same one? */
 944                         if (i < num_temp) continue;
 945
 946                         /* If the max_num_temp is too small, increase it. */
 947                         if (num_temp >= max_num_temp)
 948                         {
 949                                 cave_template_type *old_template = templates;
 950
 951                                 /* Re-allocate the "template" array */
 952                                 C_MAKE(templates, max_num_temp + 255, cave_template_type);
 953                                 (void)C_COPY(templates, old_template, max_num_temp, cave_template_type);
 954                                 C_KILL(old_template, max_num_temp, cave_template_type);
 955                                 max_num_temp += 255;
 956                         }
 957
 958                         /* Add new template */
 959                         templates[num_temp].info = c_ptr->info;
 960                         templates[num_temp].feat = c_ptr->feat;
 961                         templates[num_temp].mimic = c_ptr->mimic;
 962                         templates[num_temp].special = c_ptr->special;
 963                         templates[num_temp].occurrence = 1;
 964
 965                         /* Increase number of template */
 966                         num_temp++;
 967                 }
 968         }
 969
 970         /* Select the sort method */
 971         ang_sort_comp = ang_sort_comp_cave_temp;
 972         ang_sort_swap = ang_sort_swap_cave_temp;
 973
 974         /* Sort by occurrence */
 975         ang_sort(templates, &dummy_why, num_temp);
 976
 977
 978         /*** Dump templates ***/
 979
 980         /* Total templates */
 981         wr_u16b(num_temp);
 982
 983         /* Dump the templates */
 984         for (i = 0; i < num_temp; i++)
 985         {
 986                 cave_template_type *ct_ptr = &templates[i];
 987
 988                 /* Dump it */
 989                 wr_u16b(ct_ptr->info);
 990                 wr_s16b(ct_ptr->feat);
 991                 wr_s16b(ct_ptr->mimic);
 992                 wr_s16b(ct_ptr->special);
 993         }
 994
 995
 996
 997         /*** "Run-Length-Encoding" of cave ***/
 998
 999         /* Note that this will induce two wasted bytes */
1000         count = 0;
1001         prev_u16b = 0;
1002
1003         /* Dump the cave */
1004         for (y = 0; y < cur_hgt; y++)
1005         {
1006                 for (x = 0; x < cur_wid; x++)
1007                 {
1008                         cave_type *c_ptr = &cave[y][x];
1009
1010                         for (i = 0; i < num_temp; i++)
1011                         {
1012                                 if (templates[i].info == c_ptr->info &&
1013                                     templates[i].feat == c_ptr->feat &&
1014                                     templates[i].mimic == c_ptr->mimic &&
1015                                     templates[i].special == c_ptr->special)
1016                                         break;
1017                         }
1018
1019                         /* Extract an ID */
1020                         tmp16u = i;
1021
1022                         /* If the run is broken, or too full, flush it */
1023                         if ((tmp16u != prev_u16b) || (count == MAX_UCHAR))
1024                         {
1025                                 wr_byte((byte)count);
1026
1027                                 while (prev_u16b >= MAX_UCHAR)
1028                                 {
1029                                         /* Mark as actual data is larger than 254 */
1030                                         wr_byte(MAX_UCHAR);
1031                                         prev_u16b -= MAX_UCHAR;
1032                                 }
1033
1034                                 wr_byte((byte)prev_u16b);
1035                                 prev_u16b = tmp16u;
1036                                 count = 1;
1037                         }
1038
1039                         /* Continue the run */
1040                         else
1041                         {
1042                                 count++;
1043                         }
1044                 }
1045         }
1046
1047         /* Flush the data (if any) */
1048         if (count)
1049         {
1050                 wr_byte((byte)count);
1051
1052                 while (prev_u16b >= MAX_UCHAR)
1053                 {
1054                         /* Mark as actual data is larger than 254 */
1055                         wr_byte(MAX_UCHAR);
1056                         prev_u16b -= MAX_UCHAR;
1057                 }
1058                 wr_byte((byte)prev_u16b);
1059         }
1060
1061
1062         /* Free the "template" array */
1063         C_KILL(templates, max_num_temp, cave_template_type);
1064
1065
1066         /*** Dump objects ***/
1067
1068         /* Total objects */
1069         wr_u16b(o_max);
1070
1071         /* Dump the objects */
1072         for (i = 1; i < o_max; i++)
1073         {
1074                 object_type *o_ptr = &o_list[i];
1075
1076                 /* Dump it */
1077                 wr_item(o_ptr);
1078         }
1079
1080
1081         /*** Dump the monsters ***/
1082
1083         /* Total monsters */
1084         wr_u16b(m_max);
1085
1086         /* Dump the monsters */
1087         for (i = 1; i < m_max; i++)
1088         {
1089                 monster_type *m_ptr = &m_list[i];
1090
1091                 /* Dump it */
1092                 wr_monster(m_ptr);
1093         }
1094 }
1095
1096
1097 /*
1098  * Write the current dungeon (new method)
1099  */
1100 static bool wr_dungeon(void)
1101 {
1102         saved_floor_type *cur_sf_ptr;
1103         int i;
1104
1105         /* Forget the lite */
1106         forget_lite();
1107
1108         /* Forget the view */
1109         forget_view();
1110
1111         /* Forget the view */
1112         clear_mon_lite();
1113
1114         /* Update lite/view */
1115         p_ptr->update |= (PU_VIEW | PU_LITE | PU_MON_LITE);
1116
1117         /* Update monsters */
1118         p_ptr->update |= (PU_MONSTERS | PU_DISTANCE | PU_FLOW);
1119
1120
1121         /*** Meta info ***/
1122
1123         /* Number of floor_id used from birth */
1124         wr_s16b(max_floor_id);
1125
1126         /* Current dungeon type */
1127         wr_byte(dungeon_type);
1128
1129
1130         /*** No saved floor (On the surface etc.) ***/
1131         if (!p_ptr->floor_id)
1132         {
1133                 /* No array elements */
1134                 wr_byte(0);
1135
1136                 /* Write the current floor data */
1137                 wr_saved_floor(NULL);
1138
1139                 /* Success */
1140                 return TRUE;
1141         }
1142
1143
1144         /*** In the dungeon ***/
1145
1146         /* Number of array elements */
1147         wr_byte(MAX_SAVED_FLOORS);
1148
1149         /* Write the saved_floors array */
1150         for (i = 0; i < MAX_SAVED_FLOORS; i++)
1151         {
1152                 saved_floor_type *sf_ptr = &saved_floors[i];
1153
1154                 wr_s16b(sf_ptr->floor_id);
1155                 wr_byte(sf_ptr->savefile_id);
1156                 wr_s16b(sf_ptr->dun_level);
1157                 wr_s32b(sf_ptr->last_visit);
1158                 wr_u32b(sf_ptr->visit_mark);
1159                 wr_s16b(sf_ptr->upper_floor_id);
1160                 wr_s16b(sf_ptr->lower_floor_id);
1161         }
1162
1163         /* Extract pointer to current floor */
1164         cur_sf_ptr = get_sf_ptr(p_ptr->floor_id);
1165
1166         /* Save current floor to temporal file */
1167         if (!save_floor(cur_sf_ptr, (SLF_SECOND))) return FALSE;
1168
1169         /* Move data in temporal files to the savefile */
1170         for (i = 0; i < MAX_SAVED_FLOORS; i++)
1171         {
1172                 saved_floor_type *sf_ptr = &saved_floors[i];
1173
1174                 /* Unused element */
1175                 if (!sf_ptr->floor_id) continue;
1176
1177                 /* Load temporal saved floor file */
1178                 if (load_floor(sf_ptr, (SLF_SECOND | SLF_NO_KILL)))
1179                 {
1180                         /* Mark success */
1181                         wr_byte(0);
1182
1183                         /* Write saved floor data to the save file */
1184                         wr_saved_floor(sf_ptr);
1185                 }
1186                 else
1187                 {
1188                         /* Mark failure */
1189                         wr_byte(1);
1190                 }
1191         }
1192
1193         /* Restore current floor */
1194         if (!load_floor(cur_sf_ptr, (SLF_SECOND))) return FALSE;
1195
1196         /* Success */
1197         return TRUE;
1198 }
1199
1200
1201
1202 /*
1203  * Actually write a save-file
1204  */
1205 static bool wr_savefile_new(void)
1206 {
1207         int        i, j;
1208
1209         u32b              now;
1210
1211         byte            tmp8u;
1212         u16b            tmp16u;
1213
1214
1215         /* Compact the objects */
1216         compact_objects(0);
1217         /* Compact the monsters */
1218         compact_monsters(0);
1219
1220         /* Guess at the current time */
1221         now = time((time_t *)0);
1222
1223
1224         /* Note the operating system */
1225         sf_system = 0L;
1226
1227         /* Note when the file was saved */
1228         sf_when = now;
1229
1230         /* Note the number of saves */
1231         sf_saves++;
1232
1233
1234         /*** Actually write the file ***/
1235
1236         /* Dump the file header */
1237         xor_byte = 0;
1238         wr_byte(FAKE_VER_MAJOR);
1239         xor_byte = 0;
1240         wr_byte(FAKE_VER_MINOR);
1241         xor_byte = 0;
1242         wr_byte(FAKE_VER_PATCH);
1243         xor_byte = 0;
1244
1245         /* Initial value of xor_byte */
1246         tmp8u = (byte)randint0(256);
1247         wr_byte(tmp8u);
1248
1249
1250         /* Reset the checksum */
1251         v_stamp = 0L;
1252         x_stamp = 0L;
1253
1254         /* Write the savefile version for Hengband 1.1.1 and later */
1255         wr_byte(H_VER_EXTRA);
1256         wr_byte(H_VER_PATCH);
1257         wr_byte(H_VER_MINOR);
1258         wr_byte(H_VER_MAJOR);
1259
1260         /* Operating system */
1261         wr_u32b(sf_system);
1262
1263
1264         /* Time file last saved */
1265         wr_u32b(sf_when);
1266
1267         /* Number of past lives */
1268         wr_u16b(sf_lives);
1269
1270         /* Number of times saved */
1271         wr_u16b(sf_saves);
1272
1273
1274         /* Space */
1275         wr_u32b(0L);
1276         wr_u16b(0);
1277         wr_byte(0);
1278
1279 #ifdef JP
1280 # ifdef EUC
1281         /* EUC kanji code */
1282         wr_byte(2);
1283 # endif
1284 # ifdef SJIS
1285         /* SJIS kanji code */
1286         wr_byte(3);
1287 # endif
1288 #else
1289         /* ASCII */
1290         wr_byte(1);
1291 #endif
1292
1293         /* Write the RNG state */
1294         wr_randomizer();
1295
1296
1297         /* Write the boolean "options" */
1298         wr_options();
1299
1300
1301         /* Dump the number of "messages" */
1302         tmp16u = message_num();
1303         if (compress_savefile && (tmp16u > 40)) tmp16u = 40;
1304         wr_u16b(tmp16u);
1305
1306         /* Dump the messages (oldest first!) */
1307         for (i = tmp16u - 1; i >= 0; i--)
1308         {
1309                 wr_string(message_str((s16b)i));
1310         }
1311
1312
1313         /* Dump the monster lore */
1314         tmp16u = max_r_idx;
1315         wr_u16b(tmp16u);
1316         for (i = 0; i < tmp16u; i++) wr_lore(i);
1317
1318
1319         /* Dump the object memory */
1320         tmp16u = max_k_idx;
1321         wr_u16b(tmp16u);
1322         for (i = 0; i < tmp16u; i++) wr_xtra(i);
1323
1324         /* Dump the towns */
1325         tmp16u = max_towns;
1326         wr_u16b(tmp16u);
1327
1328         /* Dump the quests */
1329         tmp16u = max_quests;
1330         wr_u16b(tmp16u);
1331
1332         /* Dump the quests */
1333         tmp8u = MAX_RANDOM_QUEST-MIN_RANDOM_QUEST;
1334         wr_byte(tmp8u);
1335
1336         for (i = 0; i < max_quests; i++)
1337         {
1338                 /* Save status for every quest */
1339                 wr_s16b(quest[i].status);
1340
1341                 /* And the dungeon level too */
1342                 /* (prevents problems with multi-level quests) */
1343                 wr_s16b(quest[i].level);
1344
1345                 wr_byte(quest[i].complev);
1346                 wr_u32b(quest[i].comptime);
1347
1348                 /* Save quest status if quest is running */
1349                 if (quest[i].status == QUEST_STATUS_TAKEN || quest[i].status == QUEST_STATUS_COMPLETED || !is_fixed_quest_idx(i))
1350                 {
1351                         wr_s16b(quest[i].cur_num);
1352                         wr_s16b(quest[i].max_num);
1353                         wr_s16b(quest[i].type);
1354                         wr_s16b(quest[i].r_idx);
1355                         wr_s16b(quest[i].k_idx);
1356                         wr_byte(quest[i].flags);
1357                         wr_byte(quest[i].dungeon);
1358                 }
1359         }
1360
1361         /* Dump the position in the wilderness */
1362         wr_s32b(p_ptr->wilderness_x);
1363         wr_s32b(p_ptr->wilderness_y);
1364
1365         wr_byte(p_ptr->wild_mode);
1366         wr_byte(ambush_flag);
1367
1368         wr_s32b(max_wild_x);
1369         wr_s32b(max_wild_y);
1370
1371         /* Dump the wilderness seeds */
1372         for (i = 0; i < max_wild_x; i++)
1373         {
1374                 for (j = 0; j < max_wild_y; j++)
1375                 {
1376                         wr_u32b(wilderness[j][i].seed);
1377                 }
1378         }
1379
1380         /* Hack -- Dump the artifacts */
1381         tmp16u = max_a_idx;
1382         wr_u16b(tmp16u);
1383         for (i = 0; i < tmp16u; i++)
1384         {
1385                 artifact_type *a_ptr = &a_info[i];
1386                 wr_byte(a_ptr->cur_num);
1387                 wr_s16b(a_ptr->floor_id);
1388         }
1389
1390
1391
1392         /* Write the "extra" information */
1393         wr_extra();
1394
1395         /* Dump the "player hp" entries */
1396         tmp16u = PY_MAX_LEVEL;
1397         wr_u16b(tmp16u);
1398         for (i = 0; i < tmp16u; i++)
1399         {
1400                 wr_s16b(p_ptr->player_hp[i]);
1401         }
1402
1403
1404         /* Write spell data */
1405         wr_u32b(p_ptr->spell_learned1);
1406         wr_u32b(p_ptr->spell_learned2);
1407         wr_u32b(p_ptr->spell_worked1);
1408         wr_u32b(p_ptr->spell_worked2);
1409         wr_u32b(p_ptr->spell_forgotten1);
1410         wr_u32b(p_ptr->spell_forgotten2);
1411
1412         wr_s16b(p_ptr->learned_spells);
1413         wr_s16b(p_ptr->add_spells);
1414
1415         /* Dump the ordered spells */
1416         for (i = 0; i < 64; i++)
1417         {
1418                 wr_byte(p_ptr->spell_order[i]);
1419         }
1420
1421
1422         /* Write the inventory */
1423         for (i = 0; i < INVEN_TOTAL; i++)
1424         {
1425                 object_type *o_ptr = &inventory[i];
1426
1427                 /* Skip non-objects */
1428                 if (!o_ptr->k_idx) continue;
1429
1430                 /* Dump index */
1431                 wr_u16b((u16b)i);
1432
1433                 /* Dump object */
1434                 wr_item(o_ptr);
1435         }
1436
1437         /* Add a sentinel */
1438         wr_u16b(0xFFFF);
1439
1440         /* Note the towns */
1441         tmp16u = max_towns;
1442         wr_u16b(tmp16u);
1443
1444         /* Note the stores */
1445         tmp16u = MAX_STORES;
1446         wr_u16b(tmp16u);
1447
1448         /* Dump the stores of all towns */
1449         for (i = 1; i < max_towns; i++)
1450         {
1451                 for (j = 0; j < MAX_STORES; j++)
1452                 {
1453                         wr_store(&town[i].store[j]);
1454                 }
1455         }
1456
1457         /* Write the pet command settings */
1458         wr_s16b(p_ptr->pet_follow_distance);
1459         wr_s16b(p_ptr->pet_extra_flags);
1460
1461         /* Write screen dump for sending score */
1462         if (screen_dump && (p_ptr->wait_report_score || !p_ptr->is_dead))
1463         {
1464                 wr_string(screen_dump);
1465         }
1466         else
1467         {
1468                 wr_string("");
1469         }
1470
1471         /* Player is not dead, write the dungeon */
1472         if (!p_ptr->is_dead)
1473         {
1474                 /* Dump the dungeon */
1475                 if (!wr_dungeon()) return FALSE;
1476
1477                 /* Dump the ghost */
1478                 wr_ghost();
1479
1480                 /* No scripts */
1481                 wr_s32b(0);
1482         }
1483
1484
1485         /* Write the "value check-sum" */
1486         wr_u32b(v_stamp);
1487
1488         /* Write the "encoded checksum" */
1489         wr_u32b(x_stamp);
1490
1491
1492         /* Error in save */
1493         if (ferror(fff) || (fflush(fff) == EOF)) return FALSE;
1494
1495         /* Successful save */
1496         return TRUE;
1497 }
1498
1499
1500 /*
1501  * Medium level player saver
1502  *
1503  * XXX XXX XXX Angband 2.8.0 will use "fd" instead of "fff" if possible
1504  */
1505 static bool save_player_aux(char *name)
1506 {
1507         bool    ok = FALSE;
1508
1509         int             fd = -1;
1510
1511         int             mode = 0644;
1512
1513
1514         /* No file yet */
1515         fff = NULL;
1516
1517
1518         /* File type is "SAVE" */
1519         FILE_TYPE(FILE_TYPE_SAVE);
1520
1521
1522         /* Grab permissions */
1523         safe_setuid_grab();
1524
1525         /* Create the savefile */
1526         fd = fd_make(name, mode);
1527
1528         /* Drop permissions */
1529         safe_setuid_drop();
1530
1531         /* File is okay */
1532         if (fd >= 0)
1533         {
1534                 /* Close the "fd" */
1535                 (void)fd_close(fd);
1536
1537                 /* Grab permissions */
1538                 safe_setuid_grab();
1539
1540                 /* Open the savefile */
1541                 fff = my_fopen(name, "wb");
1542
1543                 /* Drop permissions */
1544                 safe_setuid_drop();
1545
1546                 /* Successful open */
1547                 if (fff)
1548                 {
1549                         /* Write the savefile */
1550                         if (wr_savefile_new()) ok = TRUE;
1551
1552                         /* Attempt to close it */
1553                         if (my_fclose(fff)) ok = FALSE;
1554                 }
1555
1556                 /* Grab permissions */
1557                 safe_setuid_grab();
1558
1559                 /* Remove "broken" files */
1560                 if (!ok) (void)fd_kill(name);
1561
1562                 /* Drop permissions */
1563                 safe_setuid_drop();
1564         }
1565
1566
1567         /* Failure */
1568         if (!ok) return (FALSE);
1569
1570         counts_write(0, playtime);
1571
1572         /* Successful save */
1573         character_saved = TRUE;
1574
1575         /* Success */
1576         return (TRUE);
1577 }
1578
1579
1580
1581 /*
1582  * Attempt to save the player in a savefile
1583  */
1584 bool save_player(void)
1585 {
1586         int             result = FALSE;
1587
1588         char    safe[1024];
1589
1590
1591 #ifdef SET_UID
1592
1593 # ifdef SECURE
1594
1595         /* Get "games" permissions */
1596         beGames();
1597
1598 # endif
1599
1600 #endif
1601
1602
1603         /* New savefile */
1604         strcpy(safe, savefile);
1605         strcat(safe, ".new");
1606
1607 #ifdef VM
1608         /* Hack -- support "flat directory" usage on VM/ESA */
1609         strcpy(safe, savefile);
1610         strcat(safe, "n");
1611 #endif /* VM */
1612
1613         /* Grab permissions */
1614         safe_setuid_grab();
1615
1616         /* Remove it */
1617         fd_kill(safe);
1618
1619         /* Drop permissions */
1620         safe_setuid_drop();
1621
1622         update_playtime();
1623
1624         /* Attempt to save the player */
1625         if (save_player_aux(safe))
1626         {
1627                 char temp[1024];
1628
1629                 /* Old savefile */
1630                 strcpy(temp, savefile);
1631                 strcat(temp, ".old");
1632
1633 #ifdef VM
1634                 /* Hack -- support "flat directory" usage on VM/ESA */
1635                 strcpy(temp, savefile);
1636                 strcat(temp, "o");
1637 #endif /* VM */
1638
1639                 /* Grab permissions */
1640                 safe_setuid_grab();
1641
1642                 /* Remove it */
1643                 fd_kill(temp);
1644
1645                 /* Preserve old savefile */
1646                 fd_move(savefile, temp);
1647
1648                 /* Activate new savefile */
1649                 fd_move(safe, savefile);
1650
1651                 /* Remove preserved savefile */
1652                 fd_kill(temp);
1653
1654                 /* Drop permissions */
1655                 safe_setuid_drop();
1656
1657                 /* Hack -- Pretend the character was loaded */
1658                 character_loaded = TRUE;
1659
1660 #ifdef VERIFY_SAVEFILE
1661
1662                 /* Lock on savefile */
1663                 strcpy(temp, savefile);
1664                 strcat(temp, ".lok");
1665
1666                 /* Grab permissions */
1667                 safe_setuid_grab();
1668
1669                 /* Remove lock file */
1670                 fd_kill(temp);
1671
1672                 /* Drop permissions */
1673                 safe_setuid_drop();
1674
1675 #endif
1676
1677                 /* Success */
1678                 result = TRUE;
1679         }
1680
1681
1682 #ifdef SET_UID
1683
1684 # ifdef SECURE
1685
1686         /* Drop "games" permissions */
1687         bePlayer();
1688
1689 # endif
1690
1691 #endif
1692
1693         /* Return the result */
1694         return (result);
1695 }
1696
1697
1698
1699 /*
1700  * Attempt to Load a "savefile"
1701  *
1702  * Version 2.7.0 introduced a slightly different "savefile" format from
1703  * older versions, requiring a completely different parsing method.
1704  *
1705  * Note that savefiles from 2.7.0 - 2.7.2 are completely obsolete.
1706  *
1707  * Pre-2.8.0 savefiles lose some data, see "load2.c" for info.
1708  *
1709  * Pre-2.7.0 savefiles lose a lot of things, see "load1.c" for info.
1710  *
1711  * On multi-user systems, you may only "read" a savefile if you will be
1712  * allowed to "write" it later, this prevents painful situations in which
1713  * the player loads a savefile belonging to someone else, and then is not
1714  * allowed to save his game when he quits.
1715  *
1716  * We return "TRUE" if the savefile was usable, and we set the global
1717  * flag "character_loaded" if a real, living, character was loaded.
1718  *
1719  * Note that we always try to load the "current" savefile, even if
1720  * there is no such file, so we must check for "empty" savefile names.
1721  */
1722 bool load_player(void)
1723 {
1724         int             fd = -1;
1725
1726         errr    err = 0;
1727
1728         byte    vvv[4];
1729
1730 #ifdef VERIFY_TIMESTAMP
1731         struct stat     statbuf;
1732 #endif
1733
1734         cptr    what = "generic";
1735
1736
1737         /* Paranoia */
1738         turn = 0;
1739
1740         /* Paranoia */
1741         p_ptr->is_dead = FALSE;
1742
1743
1744         /* Allow empty savefile name */
1745         if (!savefile[0]) return (TRUE);
1746
1747
1748 #if !defined(MACINTOSH) && !defined(WINDOWS) && !defined(VM)
1749
1750         /* XXX XXX XXX Fix this */
1751
1752         /* Verify the existance of the savefile */
1753         if (access(savefile, 0) < 0)
1754         {
1755                 /* Give a message */
1756 #ifdef JP
1757                 msg_print("¥»¡¼¥Ö¥Õ¥¡¥¤¥ë¤¬¤¢¤ê¤Þ¤»¤ó¡£");
1758 #else
1759                 msg_print("Savefile does not exist.");
1760 #endif
1761
1762                 msg_print(NULL);
1763
1764                 /* Allow this */
1765                 return (TRUE);
1766         }
1767
1768 #endif
1769
1770
1771 #ifdef VERIFY_SAVEFILE
1772
1773         /* Verify savefile usage */
1774         if (!err)
1775         {
1776                 FILE *fkk;
1777
1778                 char temp[1024];
1779
1780                 /* Extract name of lock file */
1781                 strcpy(temp, savefile);
1782                 strcat(temp, ".lok");
1783
1784                 /* Check for lock */
1785                 fkk = my_fopen(temp, "r");
1786
1787                 /* Oops, lock exists */
1788                 if (fkk)
1789                 {
1790                         /* Close the file */
1791                         my_fclose(fkk);
1792
1793                         /* Message */
1794 #ifdef JP
1795                         msg_print("¥»¡¼¥Ö¥Õ¥¡¥¤¥ë¤Ï¸½ºß»ÈÍÑÃæ¤Ç¤¹¡£");
1796 #else
1797                         msg_print("Savefile is currently in use.");
1798 #endif
1799
1800                         msg_print(NULL);
1801
1802                         /* Oops */
1803                         return (FALSE);
1804                 }
1805
1806                 /* Create a lock file */
1807                 fkk = my_fopen(temp, "w");
1808
1809                 /* Dump a line of info */
1810                 fprintf(fkk, "Lock file for savefile '%s'\n", savefile);
1811
1812                 /* Close the lock file */
1813                 my_fclose(fkk);
1814         }
1815
1816 #endif
1817
1818
1819         /* Okay */
1820         if (!err)
1821         {
1822                 /* Open the savefile */
1823                 fd = fd_open(savefile, O_RDONLY);
1824
1825                 /* No file */
1826                 if (fd < 0) err = -1;
1827
1828                 /* Message (below) */
1829 #ifdef JP
1830                 if (err) what = "¥»¡¼¥Ö¥Õ¥¡¥¤¥ë¤ò³«¤±¤Þ¤»¤ó¡£";
1831 #else
1832                 if (err) what = "Cannot open savefile";
1833 #endif
1834
1835         }
1836
1837         /* Process file */
1838         if (!err)
1839         {
1840
1841 #ifdef VERIFY_TIMESTAMP
1842                 /* Get the timestamp */
1843                 (void)fstat(fd, &statbuf);
1844 #endif
1845
1846                 /* Read the first four bytes */
1847                 if (fd_read(fd, (char*)(vvv), 4)) err = -1;
1848
1849                 /* What */
1850 #ifdef JP
1851                 if (err) what = "¥»¡¼¥Ö¥Õ¥¡¥¤¥ë¤òÆÉ¤á¤Þ¤»¤ó¡£";
1852 #else
1853                 if (err) what = "Cannot read savefile";
1854 #endif
1855
1856
1857                 /* Close the file */
1858                 (void)fd_close(fd);
1859         }
1860
1861         /* Process file */
1862         if (!err)
1863         {
1864
1865                 /* Extract version */
1866                 z_major = vvv[0];
1867                 z_minor = vvv[1];
1868                 z_patch = vvv[2];
1869                 sf_extra = vvv[3];
1870
1871
1872                 /* Clear screen */
1873                 Term_clear();
1874
1875                 /* Attempt to load */
1876                 err = rd_savefile_new();
1877
1878                 /* Message (below) */
1879 #ifdef JP
1880                 if (err) what = "¥»¡¼¥Ö¥Õ¥¡¥¤¥ë¤ò²òÀÏ½ÐÍè¤Þ¤»¤ó¡£";
1881 #else
1882                 if (err) what = "Cannot parse savefile";
1883 #endif
1884
1885         }
1886
1887         /* Paranoia */
1888         if (!err)
1889         {
1890                 /* Invalid turn */
1891                 if (!turn) err = -1;
1892
1893                 /* Message (below) */
1894 #ifdef JP
1895                 if (err) what = "¥»¡¼¥Ö¥Õ¥¡¥¤¥ë¤¬²õ¤ì¤Æ¤¤¤Þ¤¹";
1896 #else
1897                 if (err) what = "Broken savefile";
1898 #endif
1899
1900         }
1901
1902 #ifdef VERIFY_TIMESTAMP
1903         /* Verify timestamp */
1904         if (!err && !arg_wizard)
1905         {
1906                 /* Hack -- Verify the timestamp */
1907                 if (sf_when > (statbuf.st_ctime + 100) ||
1908                     sf_when < (statbuf.st_ctime - 100))
1909                 {
1910                         /* Message */
1911 #ifdef JP
1912                         what = "Ìµ¸ú¤Ê¥¿¥¤¥à¡¦¥¹¥¿¥ó¥×¤Ç¤¹";
1913 #else
1914                         what = "Invalid timestamp";
1915 #endif
1916
1917
1918                         /* Oops */
1919                         err = -1;
1920                 }
1921         }
1922 #endif
1923
1924
1925         /* Okay */
1926         if (!err)
1927         {
1928                 /* Give a conversion warning */
1929                 if ((FAKE_VER_MAJOR != z_major) ||
1930                     (FAKE_VER_MINOR != z_minor) ||
1931                     (FAKE_VER_PATCH != z_patch))
1932                 {
1933                         if (z_major == 2 && z_minor == 0 && z_patch == 6)
1934                         {
1935 #ifdef JP
1936                                 msg_print("¥Ð¡¼¥¸¥ç¥ó 2.0.* ÍÑ¤Î¥»¡¼¥Ö¥Õ¥¡¥¤¥ë¤òÊÑ´¹¤·¤Þ¤·¤¿¡£");
1937 #else
1938                                 msg_print("Converted a 2.0.* savefile.");
1939 #endif
1940
1941                         }
1942                         else
1943                         {
1944                                 /* Message */
1945 #ifdef JP
1946                                 msg_format("¥Ð¡¼¥¸¥ç¥ó %d.%d.%d ÍÑ¤Î¥»¡¼¥Ö¡¦¥Õ¥¡¥¤¥ë¤òÊÑ´¹¤·¤Þ¤·¤¿¡£",
1947                                     (z_major > 9) ? z_major-10 : z_major , z_minor, z_patch);
1948 #else
1949                                 msg_format("Converted a %d.%d.%d savefile.",
1950                                     (z_major > 9) ? z_major-10 : z_major , z_minor, z_patch);
1951 #endif
1952                         }
1953                         msg_print(NULL);
1954                 }
1955
1956                 /* Player is dead */
1957                 if (p_ptr->is_dead)
1958                 {
1959                         /* Cheat death */
1960                         if (arg_wizard)
1961                         {
1962                                 /* A character was loaded */
1963                                 character_loaded = TRUE;
1964
1965                                 /* Done */
1966                                 return (TRUE);
1967                         }
1968
1969                         /* Player is no longer "dead" */
1970                         p_ptr->is_dead = FALSE;
1971
1972                         /* Count lives */
1973                         sf_lives++;
1974
1975                         /* Done */
1976                         return (TRUE);
1977                 }
1978
1979                 /* A character was loaded */
1980                 character_loaded = TRUE;
1981
1982                 {
1983                         u32b tmp = counts_read(2);
1984                         if (tmp > p_ptr->count)
1985                                 p_ptr->count = tmp;
1986                         if (counts_read(0) > playtime || counts_read(1) == playtime)
1987                                 counts_write(2, ++p_ptr->count);
1988                         counts_write(1, playtime);
1989                 }
1990
1991                 /* Success */
1992                 return (TRUE);
1993         }
1994
1995
1996 #ifdef VERIFY_SAVEFILE
1997
1998         /* Verify savefile usage */
1999         if (TRUE)
2000         {
2001                 char temp[1024];
2002
2003                 /* Extract name of lock file */
2004                 strcpy(temp, savefile);
2005                 strcat(temp, ".lok");
2006
2007                 /* Remove lock */
2008                 fd_kill(temp);
2009         }
2010
2011 #endif
2012
2013
2014         /* Message */
2015 #ifdef JP
2016         msg_format("¥¨¥é¡¼(%s)¤¬¥Ð¡¼¥¸¥ç¥ó%d.%d.%d ÍÑ¥»¡¼¥Ö¥Õ¥¡¥¤¥ëÆÉ¤ß¹þÃæ¤ËÈ¯À¸¡£",
2017                    what, (z_major>9) ? z_major - 10 : z_major, z_minor, z_patch);
2018 #else
2019         msg_format("Error (%s) reading %d.%d.%d savefile.",
2020                    what, (z_major>9) ? z_major - 10 : z_major, z_minor, z_patch);
2021 #endif
2022         msg_print(NULL);
2023
2024         /* Oops */
2025         return (FALSE);
2026 }
2027
2028
2029 void remove_loc(void)
2030 {
2031 #ifdef VERIFY_SAVEFILE
2032         char temp[1024];
2033 #endif /* VERIFY_SAVEFILE */
2034
2035 #ifdef SET_UID
2036 # ifdef SECURE
2037
2038         /* Get "games" permissions */
2039         beGames();
2040
2041 # endif /* SECURE */
2042 #endif /* SET_UID */
2043
2044 #ifdef VERIFY_SAVEFILE
2045
2046         /* Lock on savefile */
2047         strcpy(temp, savefile);
2048         strcat(temp, ".lok");
2049
2050         /* Remove lock file */
2051         fd_kill(temp);
2052
2053 #endif /* VERIFY_SAVEFILE */
2054
2055 #ifdef SET_UID
2056 # ifdef SECURE
2057
2058         /* Drop "games" permissions */
2059         bePlayer();
2060
2061 # endif /* SECURE */
2062 #endif /* SET_UID */
2063
2064 }
2065
2066
2067 /*
2068  * Actually write a temporal saved floor file
2069  */
2070 static bool save_floor_aux(saved_floor_type *sf_ptr)
2071 {
2072         byte tmp8u;
2073
2074         /* Compact the objects */
2075         compact_objects(0);
2076         /* Compact the monsters */
2077         compact_monsters(0);
2078
2079
2080         /*** Actually write the file ***/
2081
2082         /* Initial value of xor_byte */
2083         tmp8u = (byte)randint0(256);
2084         xor_byte = 0;
2085         wr_byte(tmp8u);
2086
2087
2088         /* Reset the checksum */
2089         v_stamp = 0L;
2090         x_stamp = 0L;
2091
2092         /* Write the sign of this process */
2093         wr_u32b(saved_floor_file_sign);
2094
2095         /* Dump the dungeon floor */
2096         wr_saved_floor(sf_ptr);
2097
2098
2099         /* Write the "value check-sum" */
2100         wr_u32b(v_stamp);
2101
2102         /* Write the "encoded checksum" */
2103         wr_u32b(x_stamp);
2104
2105
2106         /* Error in save */
2107         if (ferror(fff) || (fflush(fff) == EOF)) return FALSE;
2108
2109         /* Successful save */
2110         return TRUE;
2111 }
2112
2113
2114 /*
2115  * Attempt to save the temporally saved-floor data
2116  */
2117 bool save_floor(saved_floor_type *sf_ptr, u32b mode)
2118 {
2119         FILE *old_fff = NULL;
2120         byte old_xor_byte = 0;
2121         u32b old_v_stamp = 0;
2122         u32b old_x_stamp = 0;
2123
2124         char floor_savefile[1024];
2125         int fd = -1;
2126         bool ok = FALSE;
2127
2128         if (!(mode & SLF_SECOND))
2129         {
2130 #ifdef SET_UID
2131 # ifdef SECURE
2132                 /* Get "games" permissions */
2133                 beGames();
2134 # endif
2135 #endif
2136         }
2137
2138         /* We have one file already opened */
2139         else
2140         {
2141                 /* Backup original values */
2142                 old_fff = fff;
2143                 old_xor_byte = xor_byte;
2144                 old_v_stamp = v_stamp;
2145                 old_x_stamp = x_stamp;
2146         }
2147
2148         /* New savefile */
2149         sprintf(floor_savefile, "%s.F%02d", savefile, (int)sf_ptr->savefile_id);
2150
2151         /* Grab permissions */
2152         safe_setuid_grab();
2153
2154         /* Remove it */
2155         fd_kill(floor_savefile);
2156
2157         /* Drop permissions */
2158         safe_setuid_drop();
2159
2160
2161         /* Attempt to save the player */
2162
2163         /* No file yet */
2164         fff = NULL;
2165
2166         /* File type is "SAVE" */
2167         FILE_TYPE(FILE_TYPE_SAVE);
2168
2169         /* Grab permissions */
2170         safe_setuid_grab();
2171
2172         /* Create the savefile */
2173         fd = fd_make(floor_savefile, 0644);
2174
2175         /* Drop permissions */
2176         safe_setuid_drop();
2177
2178         /* File is okay */
2179         if (fd >= 0)
2180         {
2181                 /* Close the "fd" */
2182                 (void)fd_close(fd);
2183
2184                 /* Grab permissions */
2185                 safe_setuid_grab();
2186
2187                 /* Open the savefile */
2188                 fff = my_fopen(floor_savefile, "wb");
2189
2190                 /* Drop permissions */
2191                 safe_setuid_drop();
2192
2193                 /* Successful open */
2194                 if (fff)
2195                 {
2196                         /* Write the savefile */
2197                         if (save_floor_aux(sf_ptr)) ok = TRUE;
2198
2199                         /* Attempt to close it */
2200                         if (my_fclose(fff)) ok = FALSE;
2201                 }
2202
2203                 /* Remove "broken" files */
2204                 if (!ok)
2205                 {
2206                         /* Grab permissions */
2207                         safe_setuid_grab();
2208
2209                         (void)fd_kill(floor_savefile);
2210
2211                         /* Drop permissions */
2212                         safe_setuid_drop();
2213                 }
2214         }
2215
2216         if (!(mode & SLF_SECOND))
2217         {
2218 #ifdef SET_UID
2219 # ifdef SECURE
2220                 /* Drop "games" permissions */
2221                 bePlayer();
2222 # endif
2223 #endif
2224         }
2225
2226         /* We have one file already opened */
2227         else
2228         {
2229                 /* Restore original values */
2230                 fff = old_fff;
2231                 xor_byte = old_xor_byte;
2232                 v_stamp = old_v_stamp;
2233                 x_stamp = old_x_stamp;
2234         }
2235
2236         /* Return the result */
2237         return ok;
2238 }