Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Debug info to trace item group spawning #74906

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Debug info to trace item group spawning #74906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/item.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2536,6 +2536,8 @@ void item::debug_info( std::vector<iteminfo> &info, const iteminfo_query *parts,
if( g != nullptr ) {
info.emplace_back( "BASE", string_format( "itype_id: %s",
typeId().str() ) );
info.emplace_back( "BASE", string_format( "%s",
debug_trace ) );
if( !old_owner.is_null() ) {
info.emplace_back( "BASE", string_format( _( "Old owner: %s" ),
_( get_old_owner_name() ) ) );
Expand Down
3 changes: 3 additions & 0 deletions src/item.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,9 @@ class item : public visitable
void final_info( std::vector<iteminfo> &info, const iteminfo_query *parts, int batch,
bool debug ) const;

// NOLINTNEXTLINE(cata-serialize)
std::string debug_trace = _( "spawned via item group(s):" );

/**
* Calculate all burning calculations, but don't actually apply them to item.
* DO apply them to @ref fire_data argument, though.
Expand Down
25 changes: 16 additions & 9 deletions src/item_group.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@
static const itype_id itype_corpse( "corpse" );

std::size_t Item_spawn_data::create( ItemList &list,
const time_point &birthday, spawn_flags flags ) const
const time_point &birthday, spawn_flags flags, std::string add_ctxt ) const

Check failure on line 37 in src/item_group.cpp

View workflow job for this annotation

GitHub Actions / build (src) 

unused parameter 'add_ctxt' [clang-diagnostic-unused-parameter,-warnings-as-errors]

Check failure on line 37 in src/item_group.cpp

View workflow job for this annotation

GitHub Actions / build (src) 

parameter 'add_ctxt' is unused [misc-unused-parameters,-warnings-as-errors]

Check failure on line 37 in src/item_group.cpp

View workflow job for this annotation

GitHub Actions / build (src) 

the parameter 'add_ctxt' is copied for each invocation but only used as a const reference; consider making it a const reference [performance-unnecessary-value-param,-warnings-as-errors]

Check failure on line 37 in src/item_group.cpp

View workflow job for this annotation

GitHub Actions / Basic Build and Test (Clang 10, Ubuntu, Curses) 

unused parameter 'add_ctxt' [-Werror,-Wunused-parameter]
{
RecursionList rec;
return create( list, birthday, rec, flags );
return create( list, birthday, rec, flags, context() );
}

item Item_spawn_data::create_single( const time_point &birthday ) const
Expand Down Expand Up @@ -125,11 +125,14 @@
std::shuffle( items.end() - num_items, items.end(), rng_get_engine() );

item ctr( *container_type, birthday );
ctr.debug_trace.append( context );
if( container_variant ) {
ctr.set_itype_variant( *container_variant );
}
Item_spawn_data::ItemList excess;
for( auto it = items.end() - num_items; it != items.end(); ++it ) {
// Extra space at beginning, for readability.
it->debug_trace.append( string_format( " spawned inside container %s", ctr.type_name() ) );
ret_val<void> ret = ctr.can_contain_directly( *it );
if( ret.success() ) {
const pocket_type pk_type = guess_pocket_for( ctr, *it );
Expand Down Expand Up @@ -179,6 +182,7 @@
item Single_item_creator::create_single( const time_point &birthday, RecursionList &rec ) const
{
item tmp = create_single_without_container( birthday, rec );
tmp.debug_trace.append( context() );
if( container_item ) {
tmp = tmp.in_container( *container_item, tmp.count(), sealed,
container_item_variant.value_or( "" ) );
Expand Down Expand Up @@ -260,7 +264,7 @@
}

std::size_t Single_item_creator::create( ItemList &list,
const time_point &birthday, RecursionList &rec, spawn_flags flags ) const
const time_point &birthday, RecursionList &rec, spawn_flags flags, std::string add_ctxt ) const
{
std::size_t prev_list_size = list.size();
int cnt = 1;
Expand All @@ -277,6 +281,8 @@
for( ; cnt > 0; cnt-- ) {
if( type == S_ITEM ) {
item itm = create_single_without_container( birthday, rec );
itm.debug_trace.append( add_ctxt );
itm.debug_trace.append( context() );
if( flags & spawn_flags::use_spawn_rate && !itm.has_flag( STATIC( flag_id( "MISSION_ITEM" ) ) ) &&
rng_float( 0, 1 ) > spawn_rate ) {
continue;
Expand All @@ -296,7 +302,8 @@
debugmsg( "unknown item spawn list %s", id.c_str() );
return list.size() - prev_list_size;
}
std::size_t tmp_list_size = isd->create( list, birthday, rec, flags );
std::size_t tmp_list_size = isd->create( list, birthday, rec, flags,
add_ctxt + "" + context() + "" );
cata_assert( list.size() >= tmp_list_size );
rec.pop_back();
if( modifier ) {
Expand Down Expand Up @@ -876,15 +883,15 @@
}

std::size_t Item_group::create( Item_spawn_data::ItemList &list,
const time_point &birthday, RecursionList &rec, spawn_flags flags ) const
const time_point &birthday, RecursionList &rec, spawn_flags flags, std::string add_ctxt ) const
{
std::size_t prev_list_size = list.size();
if( type == G_COLLECTION ) {
for( const auto &elem : items ) {
if( !( flags & spawn_flags::maximized ) && rng( 0, 99 ) >= elem->get_probability( false ) ) {
continue;
}
elem->create( list, birthday, rec, flags );
elem->create( list, birthday, rec, flags, add_ctxt + "" );
}
} else if( type == G_DISTRIBUTION ) {
int p = rng( 0, sum_prob - 1 );
Expand All @@ -896,13 +903,13 @@
if( ( ev_based && prob == 0 ) || p >= 0 ) {
continue;
}
elem->create( list, birthday, rec, flags );
elem->create( list, birthday, rec, flags, add_ctxt + "" );
break;
}
}
const std::size_t items_created = list.size() - prev_list_size;
put_into_container( list, items_created, container_item, container_item_variant, sealed, birthday,
on_overflow, context() );
on_overflow, add_ctxt + "" );

return list.size() - prev_list_size;
}
Expand Down Expand Up @@ -1033,7 +1040,7 @@
}
ItemList result;
result.reserve( 20 );
group->create( result, birthday, flags );
group->create( result, birthday, flags, group_id.str() );
return result;
}

Expand Down
8 changes: 4 additions & 4 deletions src/item_group.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,14 +152,14 @@ class Item_spawn_data
* @return The number of new items appended to the list
*/
virtual std::size_t create( ItemList &list, const time_point &birthday, RecursionList &rec,
spawn_flags = spawn_flags::none ) const = 0;
spawn_flags = spawn_flags::none, std::string add_ctxt = "" ) const = 0;
/**
* Instead of calculating at run-time, give a step to finalize those item_groups that has count-min but not count-max.
* The reason is
*/
virtual void finalize( const itype_id & ) = 0;
std::size_t create( ItemList &list, const time_point &birthday,
spawn_flags = spawn_flags::none ) const;
spawn_flags = spawn_flags::none, std::string add_ctxt = "" ) const;
/**
* The same as create, but create a single item only.
* The returned item might be a null item!
Expand Down Expand Up @@ -338,7 +338,7 @@ class Single_item_creator : public Item_spawn_data
void inherit_ammo_mag_chances( int ammo, int mag );

std::size_t create( ItemList &list, const time_point &birthday, RecursionList &rec,
spawn_flags ) const override;
spawn_flags, std::string add_ctxt = "" ) const override;
void finalize( const itype_id &container = itype_id::NULL_ID() ) override;
item create_single( const time_point &birthday, RecursionList &rec ) const override;
item create_single_without_container( const time_point &birthday, RecursionList &rec ) const;
Expand Down Expand Up @@ -390,7 +390,7 @@ class Item_group : public Item_spawn_data
void add_entry( std::unique_ptr<Item_spawn_data> ptr );
void finalize( const itype_id &container = itype_id::NULL_ID() )override;
std::size_t create( ItemList &list, const time_point &birthday, RecursionList &rec,
spawn_flags ) const override;
spawn_flags, std::string add_ctxt = "" ) const override;
item create_single( const time_point &birthday, RecursionList &rec ) const override;
void check_consistency( bool actually_spawn ) const override;
bool remove_item( const itype_id &itemid ) override;
Expand Down
Loading