fiddlerwoaroof/crawl - Change VICHU3LGDSE3FMPHG5KFD5CUJBQIINSIL7FDTAOY37SK4UBOBFMQC

FR 1837856: note vaults generated in dump

Include new dump section "vaults", which for game-end dumps (or any wizard-mode dumps) will include a list (by place) of all the vaults generated in the game.

The savefile now includes a player-associated CrawlHashTable (you.props), which can be used for storing player information which doesn't need to be accessed efficiently.

Created by Matthew Cline on October 26, 2009

VICHU3LGDSE3FMPHG5KFD5CUJBQIINSIL7FDTAOY37SK4UBOBFMQC

Dependencies

In channels

main

Change contents

Replacement in crawl-ref/source/tags.h at line 60 [5.161012]

B:BD[4.141] → [4.141:216]

    TAG_MINOR_VERSION  =  9      // Current version.  (Keep equal to max.)

[4.141]

[6.493]

    TAG_MINOR_YOU_PROP = 10,     // Player class has CrawlHashTable
    TAG_MINOR_VERSION  = 10      // Current version.  (Keep equal to max.)

Insertion in crawl-ref/source/tags.cc at line 1023 [5.164589]
[7.1083]
[5.184463]
```
    you.props.write(th);
```

Insertion in crawl-ref/source/tags.cc at line 1472 [5.164589]

[8.329]

    }
    if (minorVersion >= TAG_MINOR_YOU_PROP)
    {
        you.props.clear();
        you.props.read(th);

Insertion in crawl-ref/source/player.h at line 280 [5.945993]
[9.11004]
[9.11004]
```
  CrawlHashTable props;
```
Insertion in crawl-ref/source/place.h at line 50 [11.50132]
[10.1323]
[11.51775]
```
std::vector<level_id> all_dungeon_ids();
```

Insertion in crawl-ref/source/place.cc at line 201 [11.51817]

[10.1448]


std::vector<level_id> all_dungeon_ids()
{
    std::vector<level_id> out;
    for (int i = 0; i < NUM_BRANCHES; i++)
    {
        const Branch &branch = branches[i];
        for (int depth = 1; depth <= branch.depth; depth++)
            out.push_back(level_id(branch.id, depth));
    }
    return (out);
}

Insertion in crawl-ref/source/dungeon.h at line 29 [5.3428186]
[12.2990]
[12.2990]
```
#define YOU_PORTAL_VAULT_NAMES_KEY  "you_portal_vault_names_key"
```
Insertion in crawl-ref/source/dungeon.h at line 428 [5.3428186]
[12.3064]
[5.3429755]
```
std::string dump_vault_maps();
```

Insertion in crawl-ref/source/dungeon.cc at line 58 [5.3429798]

[13.3417]


#define YOU_DUNGEON_VAULTS_KEY    "you_dungeon_vaults_key"
#define YOU_PORTAL_VAULT_MAPS_KEY "you_portal_vault_maps_key"

Insertion in crawl-ref/source/dungeon.cc at line 240 [5.3429798]

[14.604]

[15.504]


static CrawlHashTable _you_vault_list;
static std::string    _portal_vault_map_name;

Insertion in crawl-ref/source/dungeon.cc at line 320 [5.3429798]

[16.2882]

[12.3285]

            // Save information in the level's properties hash table
            // so we can inlcude it in crash reports.

Insertion in crawl-ref/source/dungeon.cc at line 325 [5.3429798]

[12.3493]


            // Save information in the player's properties has table so
            // we can include it in the character dump.
            if (!_you_vault_list.empty())
            {
                const std::string lev = level_id::current().describe();
                CrawlHashTable &all_vaults =
                    you.props[YOU_DUNGEON_VAULTS_KEY].get_table();
                CrawlHashTable &this_level = all_vaults[lev].get_table();
                this_level = _you_vault_list;
            }
            else if (!_portal_vault_map_name.empty())
            {
                CrawlVector &vault_maps =
                    you.props[YOU_PORTAL_VAULT_MAPS_KEY].get_vector();
                vault_maps.push_back(_portal_vault_map_name);
            }

Insertion in crawl-ref/source/dungeon.cc at line 344 [5.3429798]

[12.3494]

[16.2882]

            if (you.level_type == LEVEL_PORTAL_VAULT)
            {
                CrawlVector &vault_names =
                    you.props[YOU_PORTAL_VAULT_NAMES_KEY].get_vector();
                vault_names.push_back(you.level_type_name);
            }

Insertion in crawl-ref/source/dungeon.cc at line 936 [5.3429798]
[17.5870]
[18.6003]
```
    _portal_vault_map_name.clear();
    _you_vault_list.clear();
```

Replacement in crawl-ref/source/dungeon.cc at line 4355 [5.3429798]

B:BD[18.7715] → [12.4480:4535]

    remember_vault_placement(LEVEL_VAULTS_KEY, place);

[18.7715]

[19.8942]

    remember_vault_placement(vault->has_tag("extra")
                             ? LEVEL_EXTRAS_KEY: LEVEL_VAULTS_KEY,
                             place);

Insertion in crawl-ref/source/dungeon.cc at line 8383 [5.3429798]

[12.6896]

    // First we store some info on the vault into the level's properties
    // hash table, so that if there's a crash the crash report can list
    // them all.

Insertion in crawl-ref/source/dungeon.cc at line 8399 [5.3429798]

[12.7467]

[20.5584]


    // Second we setup some info to be saved in the player's properties
    // hash table, so the information can be included in the character
    // dump when the player dies/quits/wins.
    if (you.level_type == LEVEL_DUNGEON
        && !place.map.has_tag("layout")
        && !place.map.has_tag_suffix("dummy")
        && !place.map.has_tag("no_dump"))
    {
        const std::string type = place.map.has_tag("extra")
            ? "extra" : "normal";
        _you_vault_list[type].get_vector().push_back(place.map.name);
    }
    else if (you.level_type == LEVEL_PORTAL_VAULT
             && place.map.orient == MAP_ENCOMPASS
             && !place.map.has_tag("no_dump"))
    {
        _portal_vault_map_name = place.map.name;
    }
}
std::string dump_vault_maps()
{
    std::string out = "";
    std::vector<level_id> levels = all_dungeon_ids();
    CrawlHashTable &vaults = you.props[YOU_DUNGEON_VAULTS_KEY].get_table();
    for (unsigned int i = 0; i < levels.size(); i++)
    {
        level_id    &lid = levels[i];
        std::string  lev = lid.describe();
        if (!vaults.exists(lev))
            continue;
        out += lid.describe() + ":\n";
        CrawlHashTable &lists = vaults[lev].get_table();
        const char *types[] = {"normal", "extra"};
        for (int j = 0; j < 2; j++)
        {
            if (!lists.exists(types[j]))
                continue;
            out += "  ";
            out += types[j];
            out += ": ";
            CrawlVector &vec = lists[types[j]].get_vector();
            for (unsigned int k = 0, size = vec.size(); k < size; k++)
            {
                out += vec[k].get_string();
                if (k < (size - 1))
                    out += ", ";
            }
            out += "\n";
        }
        out += "\n";
    }
    CrawlVector &portals = you.props[YOU_PORTAL_VAULT_MAPS_KEY].get_vector();
    if (!portals.empty())
    {
        out += "\n";
        out += "Portal vault maps: ";
        for (unsigned int i = 0, size = portals.size(); i < size; i++)
        {
            out += portals[i].get_string();
            if (i < (size - 1))
                out += ", ";
        }
        out += "\n\n";
    }
    return (out);

Insertion in crawl-ref/source/dungeon.cc at line 8483 [5.3429798]
[20.5586]
Insertion in crawl-ref/source/dat/zot.des at line 333 [22.1533]
[21.93140]
[21.93140]
```
TAGS:       no_dump
```
Replacement in crawl-ref/source/dat/zot.des at line 414 [22.1533]
B:BD[21.93441] → [21.93441:93465]
```
TAGS:       transparent
```
[21.93441]
[21.93465]
```
TAGS:       transparent no_dump
```
Replacement in crawl-ref/source/dat/zot.des at line 426 [22.1533]
B:BD[21.93621] → [21.93621:93645]
```
TAGS:       transparent
```
[21.93621]
[21.93645]
```
TAGS:       transparent no_dump
```
Replacement in crawl-ref/source/dat/zot.des at line 438 [22.1533]
B:BD[21.93796] → [21.93796:93820]
```
TAGS:       transparent
```
[21.93796]
[21.93820]
```
TAGS:       transparent no_dump
```
Replacement in crawl-ref/source/dat/zot.des at line 450 [22.1533]
B:BD[21.93971] → [21.93971:93995]
```
TAGS:       transparent
```
[21.93971]
[21.93995]
```
TAGS:       transparent no_dump
```
Replacement in crawl-ref/source/dat/vaults.des at line 284 [24.1041446]
B:BD[22.8781] → [23.5252:5271]
```
TAGS:    no_rotate
```
[22.8781]
[22.8781]
```
TAGS:    no_rotate no_dump
```
Replacement in crawl-ref/source/dat/vaults.des at line 411 [24.1041446]
B:BD[23.5326] → [23.5326:5345]
```
TAGS:    no_rotate
```
[23.5326]
[23.5345]
```
TAGS:    no_rotate no_dump
```
Replacement in crawl-ref/source/dat/shoals.des at line 241 [3.3114]
B:BD[3.7859] → [3.7859:7890]
```
TAGS:      shoal_rune water_ok
```
[3.7859]
[3.7890]
```
TAGS:      shoal_rune water_ok no_dump
```
Replacement in crawl-ref/source/dat/shoals.des at line 261 [3.3114]
B:BD[3.8238] → [3.8238:8272]
```
TAGS:    allow_dup water_ok shoal
```
[3.8238]
[3.8272]
```
TAGS:    allow_dup water_ok shoal no_dump
```

Replacement in crawl-ref/source/dat/levdes.vim at line 58 [24.1183087]

B:BD[25.761] → [26.3070:3239]

syn keyword desOrientation no_pool_fixup no_wall_fixup no_monster_gen generate_awake no_item_gen no_tele_control not_mappable no_magic_map no_secret_doors generate_loot

[25.761]

[25.916]

syn keyword desOrientation no_pool_fixup no_wall_fixup no_monster_gen generate_awake no_item_gen no_tele_control not_mappable no_magic_map no_secret_doors generate_loot no_dump

Replacement in crawl-ref/source/dat/lair.des at line 719 [22.144230]
B:BD[22.152684] → [23.13097:13116]
```
TAGS:    no_rotate
```
[22.152684]
[27.3104]
```
TAGS:    no_rotate no_dump
```
Insertion in crawl-ref/source/dat/hive.des at line 479 [22.173047]
[22.177173]
[28.18747]
```
TAGS:   no_dump
```
Replacement in crawl-ref/source/dat/hells.des at line 320 [22.182976]
B:BD[29.9861] → [29.9861:9879]
```
TAGS:   no_rotate
```
[29.9861]
[29.9879]
```
TAGS:   no_rotate no_dump
```
Insertion in crawl-ref/source/dat/crypt.des at line 787 [30.2803]
[30.11951]
[30.12040]
```
TAGS:    no_dump
```
Insertion in crawl-ref/source/dat/crypt.des at line 889 [30.2803]
[30.18399]
[30.18399]
```
TAGS:    no_dump
```
Replacement in crawl-ref/source/dat/crypt.des at line 997 [30.2803]
B:BD[30.24323] → [31.21323:21342]
```
TAGS:    no_rotate
```
[30.24323]
[30.24342]
```
TAGS:    no_rotate no_dump
```
Insertion in crawl-ref/source/dat/clua/ziggurat.lua at line 122 [32.11554]
[32.12951]
[32.12951]
```
  e.tags("no_dump")
```
Insertion in crawl-ref/source/chardump.cc at line 31 [5.4100336]
[5.4101289]
[33.1679]
```
#include "dungeon.h"
```
Insertion in crawl-ref/source/chardump.cc at line 84 [5.4100336]
[34.35060]
[34.35060]
```
static void _sdump_vault_list(dump_params &);
```
Insertion in crawl-ref/source/chardump.cc at line 138 [5.4100336]
[34.36202]
[24.1210075]
```
    { "vaults",         _sdump_vault_list    },
```

Insertion in crawl-ref/source/chardump.cc at line 1146 [5.4100336]

[35.4121]

}
static void _sdump_vault_list(dump_params &par)
{
    if (par.full_id || par.se
#ifdef WIZARD
        || you.wizard
#endif
       )
    {
        par.text += "Vault maps used:\n\n";
        par.text += dump_vault_maps();
    }

Replacement in crawl-ref/docs/options_guide.txt at line 1785 [38.63392]

B:BD[36.37725] → [37.26986:27113]

        Two optional dump sections are turns_by_place and
        kills_by_place, which add detailed statistics to where turns

[36.37725]

[37.27113]

        Two optional dump sections are "turns_by_place" and
        "kills_by_place", which add detailed statistics to where turns

Insertion in crawl-ref/docs/options_guide.txt at line 1790 [38.63392]

[39.1154]

[37.27184]


        Another optional dump section is "vaults", which will list the
        locations and names of all the vaults that have been generated
        in the game.  This will only be included in the final dump
        which happens when you die, quit or win (or in ordinary dumps
        while in wizard mode).

Insertion in crawl-ref/docs/develop/level_design.txt at line 492 [41.350]

[2.3012]

[40.29848]

          * "no_dump": Don't dump out this vault's name in the list of
             vaults generated during the game.  Use this if the vault
             is predictable (like the Vault:8 and Slime:6 vaults) or
             are for weird internal uses (like the shoalhut vaults).

FR 1837856: note vaults generated in dump

Dependencies

In channels

Change contents

Replacement in crawl-ref/source/tags.h at line 60 [5.161012]

Insertion in crawl-ref/source/tags.cc at line 1023 [5.164589]

Insertion in crawl-ref/source/tags.cc at line 1472 [5.164589]

Insertion in crawl-ref/source/player.h at line 280 [5.945993]

Insertion in crawl-ref/source/place.h at line 50 [11.50132]

Insertion in crawl-ref/source/place.cc at line 201 [11.51817]

Insertion in crawl-ref/source/dungeon.h at line 29 [5.3428186]

Insertion in crawl-ref/source/dungeon.h at line 428 [5.3428186]

Insertion in crawl-ref/source/dungeon.cc at line 58 [5.3429798]

Insertion in crawl-ref/source/dungeon.cc at line 240 [5.3429798]

Insertion in crawl-ref/source/dungeon.cc at line 320 [5.3429798]

Insertion in crawl-ref/source/dungeon.cc at line 325 [5.3429798]

Insertion in crawl-ref/source/dungeon.cc at line 344 [5.3429798]

Insertion in crawl-ref/source/dungeon.cc at line 936 [5.3429798]

Replacement in crawl-ref/source/dungeon.cc at line 4355 [5.3429798]

Insertion in crawl-ref/source/dungeon.cc at line 8383 [5.3429798]

Insertion in crawl-ref/source/dungeon.cc at line 8399 [5.3429798]

Insertion in crawl-ref/source/dungeon.cc at line 8483 [5.3429798]

Insertion in crawl-ref/source/dat/zot.des at line 333 [22.1533]

Replacement in crawl-ref/source/dat/zot.des at line 414 [22.1533]

Replacement in crawl-ref/source/dat/zot.des at line 426 [22.1533]

Replacement in crawl-ref/source/dat/zot.des at line 438 [22.1533]

Replacement in crawl-ref/source/dat/zot.des at line 450 [22.1533]

Replacement in crawl-ref/source/dat/vaults.des at line 284 [24.1041446]

Replacement in crawl-ref/source/dat/vaults.des at line 411 [24.1041446]

Replacement in crawl-ref/source/dat/shoals.des at line 241 [3.3114]

Replacement in crawl-ref/source/dat/shoals.des at line 261 [3.3114]

Replacement in crawl-ref/source/dat/levdes.vim at line 58 [24.1183087]

Replacement in crawl-ref/source/dat/lair.des at line 719 [22.144230]

Insertion in crawl-ref/source/dat/hive.des at line 479 [22.173047]

Replacement in crawl-ref/source/dat/hells.des at line 320 [22.182976]

Insertion in crawl-ref/source/dat/crypt.des at line 787 [30.2803]

Insertion in crawl-ref/source/dat/crypt.des at line 889 [30.2803]

Replacement in crawl-ref/source/dat/crypt.des at line 997 [30.2803]

Insertion in crawl-ref/source/dat/clua/ziggurat.lua at line 122 [32.11554]

Insertion in crawl-ref/source/chardump.cc at line 31 [5.4100336]

Insertion in crawl-ref/source/chardump.cc at line 84 [5.4100336]

Insertion in crawl-ref/source/chardump.cc at line 138 [5.4100336]

Insertion in crawl-ref/source/chardump.cc at line 1146 [5.4100336]

Replacement in crawl-ref/docs/options_guide.txt at line 1785 [38.63392]

Insertion in crawl-ref/docs/options_guide.txt at line 1790 [38.63392]

Insertion in crawl-ref/docs/develop/level_design.txt at line 492 [41.350]