addon_info Struct Reference

#include <info.hpp>

Collaboration diagram for addon_info:

List of all members.

Public Member Functions
	addon_info ()
	addon_info (const config &cfg)
addon_info &	operator= (const addon_info &o)
void	read (const config &cfg)
void	write (config &cfg) const
void	write_minimal (config &cfg) const
	Write only minimal WML used for state tracking (_info.cfg) files.
std::string	display_title () const
	Get a title or automatic title for display.
std::string	display_icon () const
	Get an icon path fixed for display (e.g.
std::string	display_type () const
	Get an add-on type identifier for display in the user's language.
std::set< std::string >	resolve_dependencies (const addons_list &addons) const
	Resolve an add-on's dependency tree in a recursive fashion.
Public Attributes
std::string	id
std::string	title
std::string	description
std::string	icon
version_info	version
std::string	author
int	size
int	downloads
int	uploads
ADDON_TYPE	type
std::vector< std::string >	locales
std::vector< std::string >	depends

---

Detailed Description

Definition at line 29 of file info.hpp.

---

Constructor & Destructor Documentation

addon_info::addon_info

(

)

[inline]

Definition at line 52 of file info.hpp.

addon_info::addon_info

(

const config &

cfg

)

[inline, explicit]

Definition at line 59 of file info.hpp.

References read().

Here is the call graph for this function:

---

Member Function Documentation

std::string addon_info::display_icon

(

)

const

Get an icon path fixed for display (e.g.

when TC is missing, or the image doesn't exist).

Definition at line 123 of file info.cpp.

References game_config::debug, ERR_AC, image::exists(), icon, LOG_AC, and game_config::images::missing.

Here is the call graph for this function:

std::string addon_info::display_title

(

)

const

Get a title or automatic title for display.

If the real title is empty, the returned value is the id with underscores replaced with blanks.

Todo:

FIXME: Is it even possible for the add-ons server to provide untitled add-ons in its reply anymore? Titles seem to be required at upload time.

Definition at line 114 of file info.cpp.

References make_addon_title(), and title.

Here is the call graph for this function:

std::string addon_info::display_type

(

)

const

Get an add-on type identifier for display in the user's language.

Definition at line 144 of file info.cpp.

References _, ADDON_MEDIA, ADDON_MP_CAMPAIGN, ADDON_MP_ERA, ADDON_MP_FACTION, ADDON_MP_MAPS, ADDON_MP_SCENARIO, ADDON_OTHER, ADDON_SP_CAMPAIGN, ADDON_SP_SCENARIO, and type.

addon_info& addon_info::operator=

(

const addon_info &

o

)

[inline]

Definition at line 68 of file info.hpp.

References author, depends, description, downloads, icon, id, locales, size, title, type, uploads, and version.

void addon_info::read

(

const config &

cfg

)

Definition at line 65 of file info.cpp.

References author, config::child_range(), depends, description, downloads, get_addon_type(), icon, locales, size, utils::split(), title, type, uploads, and version.

Referenced by addon_info().

Here is the call graph for this function:

Here is the caller graph for this function:

std::set< std::string > addon_info::resolve_dependencies

(

const addons_list &

addons

)

const

Resolve an add-on's dependency tree in a recursive fashion.

The returned vector contains the list of resolved dependencies for this and any other add-ons upon which it depends.

Parameters:

addons

The add-ons list.

Todo:

Tag resolved dependencies with information about where they come from, and implement more dependency tiers.

Definition at line 170 of file info.cpp.

References ERR_AC.

void addon_info::write

(

config &

cfg

)

const

Definition at line 87 of file info.cpp.

References config::add_child(), author, depends, description, downloads, get_addon_type_string(), icon, id, utils::join(), locales, size, version_info::str(), title, type, uploads, and version.

Here is the call graph for this function:

void addon_info::write_minimal

(

config &

cfg

)

const

Write only minimal WML used for state tracking (_info.cfg) files.

This currently only includes the add-on type, upload count, and version number.

Parameters:

cfg

Target WML config object.

Definition at line 107 of file info.cpp.

References get_addon_type_string(), version_info::str(), type, uploads, and version.

Referenced by addons_client::install_addon().

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

std::string addon_info::author

Definition at line 39 of file info.hpp.

Referenced by operator=(), read(), and write().

std::vector<std::string> addon_info::depends

Definition at line 49 of file info.hpp.

Referenced by operator=(), read(), and write().

std::string addon_info::description

Definition at line 33 of file info.hpp.

Referenced by operator=(), read(), and write().

int addon_info::downloads

Definition at line 42 of file info.hpp.

Referenced by operator=(), read(), and write().

std::string addon_info::icon

Definition at line 35 of file info.hpp.

Referenced by display_icon(), operator=(), read(), and write().

std::string addon_info::id

Definition at line 31 of file info.hpp.

Referenced by get_addon_tracking_info(), addons_client::install_addon(), operator=(), and write().

std::vector<std::string> addon_info::locales

Definition at line 47 of file info.hpp.

Referenced by operator=(), read(), and write().

int addon_info::size

Definition at line 41 of file info.hpp.

Referenced by operator=(), read(), and write().

std::string addon_info::title

Definition at line 32 of file info.hpp.

Referenced by display_title(), addons_client::install_addon(), operator=(), read(), and write().

ADDON_TYPE addon_info::type

Definition at line 45 of file info.hpp.

Referenced by display_type(), operator=(), read(), write(), and write_minimal().

int addon_info::uploads

Definition at line 43 of file info.hpp.

Referenced by operator=(), read(), write(), and write_minimal().

version_info addon_info::version

Definition at line 37 of file info.hpp.

Referenced by get_addon_tracking_info(), operator=(), read(), write(), and write_minimal().

---

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

• addon/info.hpp
• addon/info.cpp