titleformat_compiler Class Reference

#include <titleformat.h>

Inheritance diagram for titleformat_compiler:

List of all members.

Public Types
typedef titleformat_compiler	t_interface_entrypoint
typedef titleformat_compiler	t_interface
typedef service_base	t_interface_parent
Public Member Functions
virtual bool	compile (service_ptr_t< titleformat_object > &p_out, const char *p_spec)=0
	Returns false in case of a compilation error.
void	run (titleformat_hook *p_source, pfc::string_base &p_out, const char *p_spec)
	Helper;.
void	compile_safe (service_ptr_t< titleformat_object > &p_out, const char *p_spec)
	Should never fail, falls back to filename% in case of failure.
void	compile_force (service_ptr_t< titleformat_object > &p_out, const char *p_spec)
	Throws bug check when script can't be compiled. For use with hardcoded scripts only.
Static Public Member Functions
static void	remove_color_marks (const char *src, pfc::string_base &out)
static void	remove_forbidden_chars (titleformat_text_out *p_out, const GUID &p_inputtype, const char *p_source, t_size p_source_len, const char *p_forbidden_chars)
static void	remove_forbidden_chars_string_append (pfc::string_receiver &p_out, const char *p_source, t_size p_source_len, const char *p_forbidden_chars)
static void	remove_forbidden_chars_string (pfc::string_base &p_out, const char *p_source, t_size p_source_len, const char *p_forbidden_chars)
Static Public Attributes
static const GUID	class_guid

---

Detailed Description

Standard service for instantiating titleformat_object. Implemented by the core; do not reimplement. To instantiate, use static_api_ptr_t<titleformat_compiler>.

---

Member Typedef Documentation

typedef titleformat_compiler titleformat_compiler::t_interface_entrypoint

typedef titleformat_compiler titleformat_compiler::t_interface

Reimplemented from service_base.

typedef service_base titleformat_compiler::t_interface_parent

---

Member Function Documentation

virtual bool titleformat_compiler::compile	(	service_ptr_t< titleformat_object > &	p_out,
		const char *	p_spec
	)			[pure virtual]

Returns false in case of a compilation error.

void titleformat_compiler::run	(	titleformat_hook *	p_source,
		pfc::string_base &	p_out,
		const char *	p_spec
	)

Helper;.

void titleformat_compiler::compile_safe	(	service_ptr_t< titleformat_object > &	p_out,
		const char *	p_spec
	)

Should never fail, falls back to filename% in case of failure.

void titleformat_compiler::compile_force	(	service_ptr_t< titleformat_object > &	p_out,
		const char *	p_spec
	)			[inline]

Throws bug check when script can't be compiled. For use with hardcoded scripts only.

static void titleformat_compiler::remove_color_marks	(	const char *	src,
		pfc::string_base &	out
	)			[static]

static void titleformat_compiler::remove_forbidden_chars	(	titleformat_text_out *	p_out,
		const GUID &	p_inputtype,
		const char *	p_source,
		t_size	p_source_len,
		const char *	p_forbidden_chars
	)			[static]

static void titleformat_compiler::remove_forbidden_chars_string_append	(	pfc::string_receiver &	p_out,
		const char *	p_source,
		t_size	p_source_len,
		const char *	p_forbidden_chars
	)			[static]

static void titleformat_compiler::remove_forbidden_chars_string	(	pfc::string_base &	p_out,
		const char *	p_source,
		t_size	p_source_len,
		const char *	p_forbidden_chars
	)			[static]

---

Member Data Documentation

const GUID titleformat_compiler::class_guid [static]

Initial value:

 
{ 0x3f7674ab, 0x44c, 0x4796, { 0x88, 0x1, 0x6c, 0x44, 0x3c, 0x24, 0x4d, 0x88 } }

---

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

• foobar2000/SDK/titleformat.h
• foobar2000/SDK/guids.cpp