The Battle for Wesnoth: simple_wml::document Class Reference

The Battle for Wesnoth 1.19.5+dev

#include <simple_wml.hpp>

Public Member Functions
	document ()

	document (char *buf, INIT_BUFFER_CONTROL control=INIT_TAKE_OWNERSHIP)

	document (const char *buf, INIT_STATE state)

	document (string_span compressed_buf)

	~document ()

const char *	dup_string (const char *str)

node &	root ()

const node &	root () const

const char *	output ()

string_span	output_compressed (bool bzip2=false)

void	compress ()

std::unique_ptr< document >	clone ()

const string_span &	operator[] (const char *key) const

const string_span &	attr (const char *key) const

node *	child (const char *name)

const node *	child (const char *name) const

const node::child_list &	children (const char *name) const

node &	set_attr (const char key, const char value)

node &	set_attr_dup (const char key, const char value)

void	take_ownership_of_buffer (char *buffer)

void	swap (document &o)

void	clear ()

Static Public Member Functions
static std::string	stats ()

Static Public Attributes
static std::size_t	document_size_limit = 40000000

Private Member Functions
void	generate_root ()

	document (const document &)=delete

document &	operator= (const document &)=delete

void	attach_list ()

void	detach_list ()

Private Attributes
string_span	compressed_buf_

const char *	output_

std::vector< char * >	buffers_

node *	root_

document *	prev_

document *	next_

Detailed Description

Definition at line 234 of file simple_wml.hpp.

Constructor & Destructor Documentation

◆ document() [1/5]

simple_wml::document::document ( )

Definition at line 945 of file simple_wml.cpp.

References attach_list().

◆ document() [2/5]

simple_wml::document::document	(	char *	buf,
		INIT_BUFFER_CONTROL	control = `INIT_TAKE_OWNERSHIP`
	)

explicit

Definition at line 956 of file simple_wml.cpp.

References attach_list(), buffers_, simple_wml::INIT_TAKE_OWNERSHIP, and root_.

◆ document() [3/5]

simple_wml::document::document	(	const char *	buf,
		INIT_STATE	state
	)

Definition at line 973 of file simple_wml.cpp.

References attach_list(), simple_wml::INIT_COMPRESSED, output_, output_compressed(), and root_.

◆ document() [4/5]

simple_wml::document::document ( string_span compressed_buf )

explicit

Definition at line 991 of file simple_wml.cpp.

References attach_list(), simple_wml::string_span::begin(), buffers_, ERR_SWML, utils::get_unknown_exception_type(), output_, and root_.

◆ ~document()

simple_wml::document::~document ( )

Definition at line 1015 of file simple_wml.cpp.

References buffers_, detach_list(), i, and root_.

◆ document() [5/5]

simple_wml::document::document ( const document & )

privatedelete

Member Function Documentation

◆ attach_list()

void simple_wml::document::attach_list ( )

private

Definition at line 1162 of file simple_wml.cpp.

References next_, and prev_.

Referenced by document().

◆ attr()

const string_span& simple_wml::document::attr ( const char * key ) const

inline

Definition at line 257 of file simple_wml.hpp.

References root().

◆ child() [1/2]

node* simple_wml::document::child ( const char * name )

inline

Definition at line 261 of file simple_wml.hpp.

References simple_wml::node::child(), and root().

Referenced by server_base::async_send_error(), server_base::async_send_warning(), wesnothd::server::cleanup_game(), wesnothd::server::delete_game(), wesnothd::server::handle_join_game(), wesnothd::server::handle_player_in_game(), wesnothd::game::level_init(), wesnothd::make_add_diff(), wesnothd::make_change_diff(), wesnothd::make_delete_diff(), wesnothd::game::save_replay(), and wesnothd::server::update_game_in_lobby().

◆ child() [2/2]

const node* simple_wml::document::child ( const char * name ) const

inline

Definition at line 265 of file simple_wml.hpp.

References simple_wml::node::child(), and root().

◆ children()

const node::child_list& simple_wml::document::children ( const char * name ) const

inline

Definition at line 269 of file simple_wml.hpp.

References simple_wml::node::children(), and root().

◆ clear()

void simple_wml::document::clear ( )

Definition at line 1145 of file simple_wml.cpp.

References buffers_, compressed_buf_, i, output_, and root_.

◆ clone()

std::unique_ptr< document > simple_wml::document::clone ( )

Definition at line 1127 of file simple_wml.cpp.

References output().

Referenced by server_base::async_send_doc_queued(), and wesnothd::game::change_controller_type().

◆ compress()

void simple_wml::document::compress ( )

Definition at line 1094 of file simple_wml.cpp.

References simple_wml::string_span::begin(), buffers_, compressed_buf_, i, output_, output_compressed(), and root_.

Referenced by campaignd::server::handle_request_campaign(), campaignd::server::handle_request_campaign_list(), and campaignd::server::handle_server_id().

◆ detach_list()

void simple_wml::document::detach_list ( )

private

Definition at line 1173 of file simple_wml.cpp.

References next_, and prev_.

Referenced by ~document().

◆ dup_string()

const char * simple_wml::document::dup_string ( const char * str )

Definition at line 1027 of file simple_wml.cpp.

References buffers_.

Referenced by simple_wml::node::set_attr_dup().

◆ generate_root()

void simple_wml::document::generate_root ( )

private

Definition at line 1113 of file simple_wml.cpp.

References simple_wml::string_span::begin(), buffers_, compressed_buf_, simple_wml::string_span::empty(), output_, and root_.

Referenced by root().

◆ operator=()

document& simple_wml::document::operator= ( const document & )

privatedelete

◆ operator[]()

const string_span& simple_wml::document::operator[] ( const char * key ) const

inline

Definition at line 253 of file simple_wml.hpp.

References root().

◆ output()

const char * simple_wml::document::output ( )

Definition at line 1036 of file simple_wml.cpp.

References simple_wml::string_span::begin(), buffers_, compressed_buf_, e, simple_wml::string_span::empty(), ERR_SWML, i, simple_wml::node::is_dirty(), simple_wml::node::output(), output_, simple_wml::node::output_size(), simple_wml::node::REFRESH_CACHE, and root_.

Referenced by clone(), server_base::coro_send_doc(), output_compressed(), wesnothd::game::remove_player(), and wesnothd::game::save_replay().

◆ output_compressed()

string_span simple_wml::document::output_compressed ( bool bzip2 = false )

Definition at line 1080 of file simple_wml.cpp.

References simple_wml::string_span::begin(), buffers_, compressed_buf_, simple_wml::string_span::empty(), simple_wml::node::is_dirty(), output(), and root_.

Referenced by compress(), server_base::coro_send_doc(), and document().

◆ root() [1/2]

node& simple_wml::document::root ( )

inline

Definition at line 243 of file simple_wml.hpp.

References generate_root(), and root_.

Referenced by wesnothd::game::add_player(), wesnothd::game::allow_observers(), server_base::async_send_error(), server_base::async_send_warning(), attr(), BOOST_AUTO_TEST_CASE(), wesnothd::game::change_controller_type(), child(), children(), wesnothd::server::delete_game(), wesnothd::server::dummy_player_updates(), wesnothd::game::get_replay_filename(), wesnothd::game::get_sides_list(), wesnothd::server::handle_join_game(), wesnothd::server::handle_message(), wesnothd::server::handle_player(), wesnothd::server::handle_player_in_game(), wesnothd::server::handle_whisper(), wesnothd::game::is_reload(), wesnothd::server::load_config(), wesnothd::game::load_next_scenario(), wesnothd::server::login_client(), wesnothd::make_add_diff(), wesnothd::make_change_diff(), wesnothd::make_delete_diff(), wesnothd::game::notify_new_host(), operator[](), wesnothd::game::process_turn(), wesnothd::server::remove_player(), wesnothd::game::remove_player(), campaignd::server::send_error(), campaignd::server::send_message(), wesnothd::game::send_observerjoins(), wesnothd::game::send_observerquit(), wesnothd::server::send_password_request(), wesnothd::game::send_server_message(), wesnothd::game::send_taken_side(), wesnothd::game::send_user_list(), set_attr(), set_attr_dup(), wesnothd::game::start_game(), wesnothd::game::take_side(), and wesnothd::game::transfer_side_control().

◆ root() [2/2]

const node& simple_wml::document::root ( ) const

inline

Definition at line 244 of file simple_wml.hpp.

References generate_root(), and root_.

◆ set_attr()

node& simple_wml::document::set_attr	(	const char *	key,
		const char *	value
	)

inline

Definition at line 273 of file simple_wml.hpp.

References root(), and simple_wml::node::set_attr().

◆ set_attr_dup()

node& simple_wml::document::set_attr_dup	(	const char *	key,
		const char *	value
	)

inline

Definition at line 277 of file simple_wml.hpp.

References root(), and simple_wml::node::set_attr_dup().

Referenced by wesnothd::server::login_client(), and wesnothd::game::save_replay().

◆ stats()

std::string simple_wml::document::stats ( )

static

Definition at line 1189 of file simple_wml.cpp.

References d, and s.

Referenced by wesnothd::server::wml_handler().

◆ swap()

void simple_wml::document::swap ( document & o )

Definition at line 1134 of file simple_wml.cpp.

References buffers_, compressed_buf_, output_, root_, simple_wml::node::set_doc(), and simple_wml::swap().

Referenced by simple_wml::swap().

◆ take_ownership_of_buffer()

void simple_wml::document::take_ownership_of_buffer ( char * buffer )

inline

Definition at line 281 of file simple_wml.hpp.

References buffers_.

Referenced by simple_wml::node::apply_diff(), and simple_wml::node::set_attr_dup().

Member Data Documentation

◆ buffers_

std::vector<char*> simple_wml::document::buffers_

private

Definition at line 298 of file simple_wml.hpp.

Referenced by clear(), compress(), document(), dup_string(), generate_root(), output(), output_compressed(), swap(), take_ownership_of_buffer(), and ~document().

◆ compressed_buf_

string_span simple_wml::document::compressed_buf_

private

Definition at line 296 of file simple_wml.hpp.

Referenced by clear(), compress(), generate_root(), output(), output_compressed(), and swap().

◆ document_size_limit

std::size_t simple_wml::document::document_size_limit = 40000000

static

Definition at line 290 of file simple_wml.hpp.

Referenced by server_base::coro_receive_doc(), and campaignd::server::load_config().

◆ next_

document* simple_wml::document::next_

private

Definition at line 305 of file simple_wml.hpp.

Referenced by attach_list(), and detach_list().

◆ output_

const char* simple_wml::document::output_

private

Definition at line 297 of file simple_wml.hpp.

Referenced by clear(), compress(), document(), generate_root(), output(), and swap().

◆ prev_

document* simple_wml::document::prev_

private

Definition at line 304 of file simple_wml.hpp.

Referenced by attach_list(), and detach_list().

◆ root_

node* simple_wml::document::root_

private

Definition at line 299 of file simple_wml.hpp.

Referenced by clear(), compress(), document(), generate_root(), output(), output_compressed(), root(), swap(), and ~document().

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

server/common/simple_wml.hpp
server/common/simple_wml.cpp