Pol  Revision:3cfda13
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
Pol::Clib::ConfigElem Class Reference

#include <cfgelem.h>

+ Inheritance diagram for Pol::Clib::ConfigElem:

Public Member Functions

 ConfigElem ()
 
virtual ~ConfigElem ()
 
void add_prop (const char *propname, const char *str)
 
void add_prop (const char *propname, unsigned int lval)
 
void add_prop (const char *propname, unsigned short sval)
 
void add_prop (const char *propname, short sval)
 
void clear_prop (const char *propname)
 
virtual size_t estimateSize () const POL_OVERRIDE
 
void get_prop (const char *propname, unsigned int *plong) const
 
bool has_prop (const char *propname) const
 
bool read_prop (const char *propname, std::string *value) const
 
std::string read_string (const char *propname) const
 
std::string read_string (const char *propname, const char *dflt) const
 
bool remove_bool (const char *propname)
 
bool remove_bool (const char *propname, bool dflt)
 
double remove_double (const char *propname, double dflt)
 
bool remove_first_prop (std::string *propname, std::string *value)
 
float remove_float (const char *propname, float dflt)
 
int remove_int (const char *propname)
 
int remove_int (const char *propname, int dflt)
 
bool remove_prop (const char *propname, std::string *value)
 
bool remove_prop (const char *propname, unsigned int *plong)
 
bool remove_prop (const char *propname, unsigned short *pushort)
 
std::string remove_string (const char *propname)
 
std::string remove_string (const char *propname, const char *dflt)
 
unsigned int remove_ulong (const char *propname)
 
unsigned int remove_ulong (const char *propname, unsigned int dflt)
 
unsigned remove_unsigned (const char *propname)
 
unsigned remove_unsigned (const char *propname, int dflt)
 
unsigned short remove_ushort (const char *propname)
 
unsigned short remove_ushort (const char *propname, unsigned short dflt)
 
void set_rest (const char *newrest)
 
void set_source (const ConfigElem &elem)
 
void set_source (const ConfigSource *source)
 
void set_type (const char *newtype)
 
POL_NORETURN void throw_error (const std::string &errmsg) const
 
void warn (const std::string &errmsg) const
 
void warn_with_line (const std::string &errmsg) const
 
- Public Member Functions inherited from Pol::Clib::ConfigElemBase
virtual ~ConfigElemBase ()
 
const char * rest () const
 
const char * type () const
 
bool type_is (const char *name) const
 

Protected Types

typedef std::multimap< std::string, std::string, ci_cmp_pred > Props
 

Protected Member Functions

POL_NORETURN void prop_not_found (const char *propname) const
 
- Protected Member Functions inherited from Pol::Clib::ConfigElemBase
 ConfigElemBase ()
 

Protected Attributes

Props properties
 
- Protected Attributes inherited from Pol::Clib::ConfigElemBase
const ConfigSource * _source
 
std::string rest_
 
std::string type_
 

Friends

class ConfigFile
 

Detailed Description

Definition at line 57 of file cfgelem.h.

Member Typedef Documentation

typedef std::multimap<std::string, std::string, ci_cmp_pred> Pol::Clib::ConfigElem::Props
protected

Definition at line 120 of file cfgelem.h.

Constructor & Destructor Documentation

Pol::Clib::ConfigElem::ConfigElem ( )

Definition at line 66 of file cfgfile.cpp.

Pol::Clib::ConfigElem::~ConfigElem ( )
virtual

Definition at line 68 of file cfgfile.cpp.

Member Function Documentation

void Pol::Clib::ConfigElem::add_prop ( const char *  propname,
const char *  str 
)

Definition at line 503 of file cfgfile.cpp.

References properties.

Referenced by Pol::Testing::add_npc(), Pol::Items::create_intrinsic_shield_from_npctemplate(), Pol::Items::create_intrinsic_weapon_from_npctemplate(), Pol::Accounts::create_new_account(), Pol::Items::CreateItemDescriptor(), Pol::Accounts::duplicate_account(), Pol::Module::UOExecutorModule::mf_CreateNpcFromTemplate(), Pol::Core::PropertyList::printProperties(), Pol::Module::replace_properties(), Pol::Accounts::reread_account(), and Pol::Accounts::Account::writeto().

void Pol::Clib::ConfigElem::add_prop ( const char *  propname,
unsigned int  lval 
)

Definition at line 542 of file cfgfile.cpp.

References OSTRINGSTREAM, OSTRINGSTREAM_STR, and properties.

void Pol::Clib::ConfigElem::add_prop ( const char *  propname,
unsigned short  sval 
)

Definition at line 516 of file cfgfile.cpp.

References OSTRINGSTREAM, OSTRINGSTREAM_STR, and properties.

void Pol::Clib::ConfigElem::add_prop ( const char *  propname,
short  sval 
)

Definition at line 523 of file cfgfile.cpp.

References OSTRINGSTREAM, OSTRINGSTREAM_STR, and properties.

void Pol::Clib::ConfigElem::clear_prop ( const char *  propname)

Definition at line 496 of file cfgfile.cpp.

References Pol::Testing::dummy(), and remove_prop().

Referenced by Pol::Testing::add_npc(), Pol::Module::UOExecutorModule::mf_CreateNpcFromTemplate(), and Pol::Module::replace_properties().

size_t Pol::Clib::ConfigElem::estimateSize ( ) const
virtual

Reimplemented from Pol::Clib::ConfigElemBase.

Definition at line 70 of file cfgfile.cpp.

References Pol::Clib::ConfigElemBase::estimateSize(), and properties.

Referenced by Pol::Core::NpcTemplateElem::estimateSize().

void Pol::Clib::ConfigElem::get_prop ( const char *  propname,
unsigned int *  plong 
) const

Definition at line 198 of file cfgfile.cpp.

References properties, and throw_error().

Referenced by Pol::Core::StorageArea::load_item(), Pol::Core::read_character(), Pol::Core::read_global_item(), Pol::Core::read_multi(), and Pol::Core::read_npc().

bool Pol::Clib::ConfigElem::has_prop ( const char *  propname) const

Definition at line 125 of file cfgfile.cpp.

References properties.

Referenced by Pol::Items::create_intrinsic_weapon_from_npctemplate(), Pol::Core::load_anim_xlate_cfg(), Pol::Network::load_packet_entries(), Pol::Network::load_subpacket_entries(), Pol::UoConvert::UoConvertMain::main(), Pol::Core::NpcTemplate::NpcTemplate(), Pol::Accounts::Account::readfrom(), Pol::Items::UWeapon::readProperties(), and Pol::Items::WeaponDesc::WeaponDesc().

void Pol::Clib::ConfigElem::prop_not_found ( const char *  propname) const
protected

Definition at line 323 of file cfgfile.cpp.

References throw_error().

Referenced by read_string(), remove_string(), remove_ulong(), and remove_ushort().

bool Pol::Clib::ConfigElem::read_prop ( const char *  propname,
std::string *  value 
) const

Definition at line 172 of file cfgfile.cpp.

References properties.

Referenced by read_string().

std::string Pol::Clib::ConfigElem::read_string ( const char *  propname) const

Definition at line 408 of file cfgfile.cpp.

References prop_not_found(), and read_prop().

Referenced by Pol::Module::UOExecutorModule::mf_CreateNpcFromTemplate(), Pol::Core::NpcTemplate::NpcTemplate(), and Pol::Plib::Package::Package().

std::string Pol::Clib::ConfigElem::read_string ( const char *  propname,
const char *  dflt 
) const

Definition at line 421 of file cfgfile.cpp.

References read_prop().

bool Pol::Clib::ConfigElem::remove_bool ( const char *  propname)

Definition at line 439 of file cfgfile.cpp.

References remove_ushort().

Referenced by Pol::Core::load_anim_xlate_cfg(), Pol::Core::load_party_cfg_general(), Pol::Core::load_protocol_entry(), Pol::Core::load_repsys_cfg_general(), Pol::UoConvert::UoConvertMain::main(), Pol::Core::CombatConfig::read_combat_config(), Pol::Core::PolConfig::read_pol_config(), Pol::Core::ServSpecOpt::read_servspecopt(), Pol::Mobile::Character::readCommonProperties(), Pol::Plib::readflags(), Pol::Accounts::Account::readfrom(), Pol::Mobile::NPC::readNpcProperties(), Pol::Core::ULockable::readProperties(), Pol::Core::UCorpse::readProperties(), Pol::Core::Map::readProperties(), Pol::Multi::UHouse::readProperties(), Pol::Core::UContainer::readProperties(), Pol::Items::Item::readProperties(), and Pol::Core::set_watch_vars().

bool Pol::Clib::ConfigElem::remove_bool ( const char *  propname,
bool  dflt 
)

Definition at line 444 of file cfgfile.cpp.

References remove_ushort().

double Pol::Clib::ConfigElem::remove_double ( const char *  propname,
double  dflt 
)

Definition at line 461 of file cfgfile.cpp.

References remove_prop().

Referenced by Pol::Core::read_movecost(), Pol::Core::ServSpecOpt::read_servspecopt(), Pol::Mobile::Character::readCommonProperties(), and Pol::Items::Item::readProperties().

bool Pol::Clib::ConfigElem::remove_first_prop ( std::string *  propname,
std::string *  value 
)

Definition at line 113 of file cfgfile.cpp.

References properties.

Referenced by Pol::Core::load_anim_xlate_cfg(), Pol::Core::load_incremental_indexes(), Pol::Core::Menu::read_menus(), Pol::Core::read_movecost(), Pol::Core::PropertyList::readRemainingPropertiesAsStrings(), and Pol::Core::StoredConfigElem::StoredConfigElem().

float Pol::Clib::ConfigElem::remove_float ( const char *  propname,
float  dflt 
)

Definition at line 449 of file cfgfile.cpp.

References remove_prop().

int Pol::Clib::ConfigElem::remove_int ( const char *  propname)

Definition at line 353 of file cfgfile.cpp.

References remove_string().

Referenced by Pol::UoConvert::UoConvertMain::main(), Pol::Core::PolConfig::read_pol_config(), Pol::Core::ServSpecOpt::read_servspecopt(), Pol::Mobile::Character::readCommonProperties(), Pol::Items::UArmor::readProperties(), Pol::Items::UWeapon::readProperties(), Pol::Core::UContainer::readProperties(), Pol::Core::UObject::readProperties(), and Pol::Items::Item::readProperties().

int Pol::Clib::ConfigElem::remove_int ( const char *  propname,
int  dflt 
)

Definition at line 360 of file cfgfile.cpp.

References remove_prop().

bool Pol::Clib::ConfigElem::remove_prop ( const char *  propname,
std::string *  value 
)

Definition at line 141 of file cfgfile.cpp.

References properties.

Referenced by Pol::Items::ArmorDesc::ArmorDesc(), Pol::Mobile::Attribute::Attribute(), Pol::Network::AuxService::AuxService(), Pol::Multi::BoatShape::BoatShape(), Pol::Core::checka(), Pol::Core::checkv(), clear_prop(), Pol::Core::CmdLevel::CmdLevel(), Pol::Items::create_intrinsic_shield_from_npctemplate(), Pol::Items::create_intrinsic_weapon_from_npctemplate(), Pol::Core::equip_from_template(), Pol::Module::FileAccess::FileAccess(), Pol::Items::ItemDesc::ItemDesc(), Pol::Mobile::load_armor_zones(), Pol::Core::ConsoleCommand::load_console_commands(), Pol::Core::load_general_entry(), Pol::Core::StorageArea::load_item(), Pol::Core::load_mime_config(), Pol::Plib::load_packages(), Pol::Network::load_packet_entries(), Pol::Network::load_packethook_length(), Pol::Network::load_packethook_version(), Pol::Core::load_party_cfg_hooks(), Pol::Core::load_repsys_cfg_hooks(), Pol::Core::load_resource_cfg(), Pol::Mobile::NPC::loadEquipablePropertiesNPC(), Pol::Multi::MultiDef::MultiDef(), Pol::Core::MusicRegion::MusicRegion(), Pol::Plib::PackageList::PackageList(), Pol::Core::RegionGroupBase::paint_zones(), Pol::Core::Party::Party(), Pol::Core::process_package_cmds_cfg(), Pol::Core::ResourceDef::read_config(), Pol::Core::read_gameservers(), Pol::Core::read_global_item(), Pol::Core::read_item(), Pol::Core::read_multi(), Pol::Core::read_starting_locations(), Pol::Mobile::Character::readAttributesAndVitals(), Pol::Mobile::Character::readCommonProperties(), Pol::Mobile::NPC::readNewNpcAttributes(), Pol::Mobile::NPC::readNpcProperties(), Pol::Core::UCorpse::readProperties(), Pol::Multi::UHouse::readProperties(), Pol::Multi::CustomHouseDesign::readProperties(), Pol::Core::PropertyList::readProperties(), Pol::Multi::UBoat::readProperties(), remove_double(), remove_float(), remove_int(), remove_prop(), remove_string(), remove_ulong(), remove_unsigned(), remove_ushort(), Pol::Core::SerialSet::SerialSet(), Pol::Core::USpell::USpell(), and Pol::Core::Vital::Vital().

bool Pol::Clib::ConfigElem::remove_prop ( const char *  propname,
unsigned int *  plong 
)

Definition at line 211 of file cfgfile.cpp.

References properties.

bool Pol::Clib::ConfigElem::remove_prop ( const char *  propname,
unsigned short *  pushort 
)

Definition at line 242 of file cfgfile.cpp.

References remove_prop(), and throw_error().

std::string Pol::Clib::ConfigElem::remove_string ( const char *  propname)

Definition at line 394 of file cfgfile.cpp.

References prop_not_found(), and remove_prop().

Referenced by Pol::Multi::BoatShape::BoatShape(), Pol::Core::Storage::create_area(), Pol::Items::create_intrinsic_weapon_from_npctemplate(), Pol::Accounts::duplicate_account(), Pol::Core::FindNpcTemplate(), Pol::Core::load_anim_xlate_cfg(), Pol::Mobile::load_armor_zones(), Pol::Network::load_packet_entries(), Pol::Core::load_party_cfg_general(), Pol::Network::load_subpacket_entries(), Pol::Core::load_tile_entry(), Pol::UoConvert::UoConvertMain::main(), Pol::UoTool::UoToolMain::main(), Pol::Plib::Package::Package(), Pol::Core::RegionGroupBase::paint_zones(), Pol::Network::read_bannedips_config(), Pol::Core::read_gameservers(), Pol::Core::Menu::read_menus(), Pol::Core::PolConfig::read_pol_config(), Pol::Core::read_region_data(), Pol::Core::read_shadow_realms(), Pol::Core::read_stacking_cfg(), Pol::Core::read_starting_locations(), Pol::Mobile::Character::readCommonProperties(), Pol::Accounts::Account::readfrom(), Pol::Mobile::NPC::readNpcProperties(), Pol::Items::UArmor::readProperties(), Pol::Items::UWeapon::readProperties(), Pol::Core::Map::readProperties(), Pol::Core::UObject::readProperties(), Pol::Items::Item::readProperties(), remove_int(), remove_unsigned(), Pol::Accounts::reread_account(), Pol::Core::ServSpecOpt::ssopt_parse_totalstats(), Pol::Core::UoClientListener::UoClientListener(), and Pol::Items::WeaponDesc::WeaponDesc().

std::string Pol::Clib::ConfigElem::remove_string ( const char *  propname,
const char *  dflt 
)

Definition at line 430 of file cfgfile.cpp.

References remove_prop().

unsigned int Pol::Clib::ConfigElem::remove_ulong ( const char *  propname)

Definition at line 474 of file cfgfile.cpp.

References prop_not_found(), and remove_prop().

Referenced by Pol::Core::load_landtile_entry(), Pol::Core::load_tile_entry(), Pol::Core::Party::Party(), Pol::Core::CombatConfig::read_combat_config(), Pol::Core::ResourceDef::read_config(), Pol::Core::ResourceRegion::read_data(), Pol::Core::ResourceDef::read_data(), Pol::Core::read_guilds_dat(), Pol::Core::PolConfig::read_pol_config(), Pol::Core::ServSpecOpt::read_servspecopt(), Pol::Core::read_system_vars(), Pol::Mobile::Character::readCommonProperties(), Pol::Mobile::NPC::readNpcProperties(), Pol::Core::UObject::readProperties(), Pol::Items::Item::readProperties(), and Pol::Mobile::Character::readProperties().

unsigned int Pol::Clib::ConfigElem::remove_ulong ( const char *  propname,
unsigned int  dflt 
)

Definition at line 487 of file cfgfile.cpp.

References remove_prop().

unsigned Pol::Clib::ConfigElem::remove_unsigned ( const char *  propname)

Definition at line 373 of file cfgfile.cpp.

References remove_string().

Referenced by Pol::Core::read_extobj(), Pol::Core::PolConfig::read_pol_config(), Pol::Core::read_starting_locations(), and Pol::Mobile::Character::readCommonProperties().

unsigned Pol::Clib::ConfigElem::remove_unsigned ( const char *  propname,
int  dflt 
)

Definition at line 380 of file cfgfile.cpp.

References remove_prop().

unsigned short Pol::Clib::ConfigElem::remove_ushort ( const char *  propname)

Definition at line 331 of file cfgfile.cpp.

References prop_not_found(), and remove_prop().

Referenced by Pol::Testing::add_npc(), Pol::Items::ItemDesc::ItemDesc(), Pol::Core::load_anim_xlate_cfg(), Pol::Mobile::load_armor_zones(), Pol::Core::load_general_entry(), Pol::Core::load_party_cfg_general(), Pol::Core::load_repsys_cfg_general(), Pol::Core::load_repsys_cfg_namecoloring(), Pol::Network::load_subpacket_entries(), Pol::Core::load_tile_entry(), Pol::UoConvert::UoConvertMain::main(), Pol::UoTool::UoToolMain::main(), Pol::Module::UOExecutorModule::mf_CreateNpcFromTemplate(), Pol::Plib::MapWriter::OpenExistingFiles(), Pol::Plib::Package::Package(), Pol::Multi::read_boat_cfg(), Pol::Core::read_character(), Pol::Core::read_gameservers(), Pol::Core::read_npc(), Pol::Core::PolConfig::read_pol_config(), Pol::Core::ServSpecOpt::read_servspecopt(), Pol::Core::read_starting_locations(), Pol::Core::read_system_vars(), Pol::Mobile::Character::readCommonProperties(), Pol::Mobile::NPC::readNpcProperties(), Pol::Core::Spellbook::readProperties(), Pol::Core::UCorpse::readProperties(), Pol::Core::Map::readProperties(), Pol::Multi::UHouse::readProperties(), Pol::Core::UObject::readProperties(), Pol::Multi::UBoat::readProperties(), Pol::Items::Item::readProperties(), Pol::Items::remove_action(), remove_bool(), and Pol::Items::WeaponDesc::WeaponDesc().

unsigned short Pol::Clib::ConfigElem::remove_ushort ( const char *  propname,
unsigned short  dflt 
)

Definition at line 344 of file cfgfile.cpp.

References remove_prop().

void Pol::Clib::ConfigElem::set_rest ( const char *  newrest)

Definition at line 89 of file cfgfile.cpp.

References Pol::Clib::ConfigElemBase::rest(), and Pol::Clib::ConfigElemBase::rest_.

Referenced by Pol::Items::create_intrinsic_shield_from_npctemplate(), Pol::Items::create_intrinsic_weapon_from_npctemplate(), Pol::Items::CreateItemDescriptor(), Pol::Core::FindNpcTemplate(), and Pol::Items::load_npc_intrinsic_equip().

void Pol::Clib::ConfigElem::set_source ( const ConfigElem &  elem)

Definition at line 99 of file cfgfile.cpp.

References Pol::Clib::ConfigElemBase::_source.

Referenced by Pol::Core::NpcTemplateElem::copyto(), Pol::Items::create_intrinsic_shield_from_npctemplate(), Pol::Items::create_intrinsic_weapon_from_npctemplate(), and Pol::Items::CreateItemDescriptor().

void Pol::Clib::ConfigElem::set_source ( const ConfigSource *  source)

Definition at line 103 of file cfgfile.cpp.

References Pol::Clib::ConfigElemBase::_source.

void Pol::Clib::ConfigElem::set_type ( const char *  newtype)

Definition at line 94 of file cfgfile.cpp.

References Pol::Clib::ConfigElemBase::type(), and Pol::Clib::ConfigElemBase::type_.

Referenced by Pol::Items::CreateItemDescriptor().

void Pol::Clib::ConfigElem::throw_error ( const std::string &  errmsg) const

Definition at line 298 of file cfgfile.cpp.

References Pol::Clib::ConfigElemBase::_source, and Pol::Clib::ConfigSource::display_error().

Referenced by Pol::Core::checka(), Pol::Core::checkv(), Pol::Core::ConsoleCommand::ConsoleCommand(), Pol::Items::ItemDesc::create(), Pol::Core::FindExportedFunction(), get_prop(), Pol::Items::ItemDesc::ItemDesc(), Pol::Plib::RealmDescriptor::Load(), Pol::Mobile::load_attribute_entry(), Pol::Network::load_packet_entries(), Pol::Network::load_packethook_length(), Pol::Network::load_packethook_version(), Pol::Core::load_skill_entry(), Pol::Network::load_subpacket_entries(), Pol::Core::load_vital_entry(), Pol::Clib::ConfigSection::matches(), Pol::Multi::MultiDef::MultiDef(), Pol::Items::MultiDesc::MultiDesc(), Pol::Network::packethook_assert_valid_parent(), Pol::Core::RegionGroupBase::paint_zones(), Pol::Core::process_package_cmds_cfg(), prop_not_found(), Pol::Items::read_itemdesc_file(), Pol::Core::read_movecost(), Pol::Mobile::Character::readAttributesAndVitals(), Pol::Mobile::Character::readCommonProperties(), Pol::Accounts::Account::readfrom(), Pol::Mobile::NPC::readNewNpcAttributes(), Pol::Items::remove_action(), remove_prop(), Pol::Clib::VectorConfigElem::remove_prop(), Pol::Core::str_to_action(), Pol::Core::UOSkill::UOSkill(), Pol::Core::USpell::USpell(), and Pol::Items::WeaponDesc::WeaponDesc().

void Pol::Clib::ConfigElem::warn ( const std::string &  errmsg) const

Definition at line 311 of file cfgfile.cpp.

References Pol::Clib::ConfigElemBase::_source, and Pol::Clib::ConfigSource::display_error().

Referenced by Pol::Core::UOSkill::UOSkill(), and Pol::Items::WeaponDesc::WeaponDesc().

void Pol::Clib::ConfigElem::warn_with_line ( const std::string &  errmsg) const

Definition at line 317 of file cfgfile.cpp.

References Pol::Clib::ConfigElemBase::_source, and Pol::Clib::ConfigSource::display_error().

Referenced by Pol::Core::StorageArea::load_item(), Pol::Core::read_global_item(), Pol::Core::read_item(), and Pol::Core::read_shadow_realms().

Friends And Related Function Documentation

friend class ConfigFile
friend

Definition at line 63 of file cfgelem.h.

Member Data Documentation

Props Pol::Clib::ConfigElem::properties
protected

Definition at line 121 of file cfgelem.h.

Referenced by Pol::Clib::ConfigFile::_read(), add_prop(), Pol::Clib::VectorConfigElem::add_prop(), estimateSize(), get_prop(), has_prop(), Pol::Clib::VectorConfigElem::has_prop(), read_prop(), Pol::Clib::VectorConfigElem::read_prop(), Pol::Clib::ConfigFile::read_properties(), remove_first_prop(), Pol::Clib::VectorConfigElem::remove_first_prop(), remove_prop(), Pol::Clib::VectorConfigElem::remove_prop(), and Pol::Clib::ConfigFile::~ConfigFile().

The documentation for this class was generated from the following files: