titleformat_compiler

#include <titleformat.h>

Inheritance diagram for titleformat_compiler:

Public Member Functions
virtual bool	compile (titleformat_object::ptr &p_out, const char *p_spec)=0
void	compile_force (titleformat_object::ptr &p_out, const char *p_spec)
void	compile_safe (titleformat_object::ptr &p_out, const char *p_spec)
void	compile_safe_ex (titleformat_object::ptr &p_out, const char *p_spec, const char *p_fallback="<ERROR>")
	FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (titleformat_compiler)
void	run (titleformat_hook *p_source, pfc::string_base &p_out, const char *p_spec)
Public Member Functions inherited from service_base
template<typename outPtr_t >
bool	cast (outPtr_t &outPtr)
virtual int	service_add_ref ()=0 throw ()
virtual bool	service_query (service_ptr_t< service_base > &p_out, const GUID &p_guid)
template<class T >
bool	service_query_t (service_ptr_t< T > &p_out)
virtual int	service_release ()=0 throw ()

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 (pfc::string_base &p_out, 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)

Additional Inherited Members
Public Types inherited from service_base
typedef service_base	t_interface
Protected Member Functions inherited from service_base
	service_base ()
	~service_base ()

Detailed Description

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

Definition at line 54 of file titleformat.h.

Member Function Documentation

virtual bool titleformat_compiler::compile ( titleformat_object::ptr &  p_out, const char *  p_spec  )

pure virtual

Returns false in case of a compilation error.

void titleformat_compiler::compile_force ( titleformat_object::ptr &  p_out, const char *  p_spec  )

inline

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

Definition at line 68 of file titleformat.h.

{if (!compile(p_out,p_spec)) uBugCheck();}

void titleformat_compiler::compile_safe	(	titleformat_object::ptr &	p_out,
		const char *	p_spec
	)

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

Definition at line 156 of file titleformat.cpp.

{
    if (!compile(p_out,p_spec)) {
        compile_force(p_out,"%filename%");
    }
}

void titleformat_compiler::compile_safe_ex	(	titleformat_object::ptr &	p_out,
		const char *	p_spec,
		const char *	p_fallback = "<ERROR>"
	)

Falls back to p_fallback in case of failure.

Definition at line 176 of file titleformat.cpp.

                                                                                                                    {
    if (!compile(p_out,p_spec)) compile_force(p_out,p_fallback);
}

titleformat_compiler::FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT

(

titleformat_compiler

)

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

static

Definition at line 6 of file titleformat.cpp.

{
    out.reset();
    while(*src)
    {
        if (*src==3)
        {
            src++;
            while(*src && *src!=3) src++;
            if (*src==3) src++;
        }
        else out.add_byte(*src++);
    }
}

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

Definition at line 26 of file titleformat.cpp.

{
    if (p_reserved_chars == 0 || *p_reserved_chars == 0)
    {
        p_out->write(p_inputtype,p_source,p_source_len);
    }
    else
    {
        p_source_len = pfc::strlen_max(p_source,p_source_len);
        t_size index = 0;
        t_size good_byte_count = 0;
        while(index < p_source_len)
        {
            t_size delta = pfc::utf8_char_len(p_source + index,p_source_len - index);
            if (delta == 0) break;
            if (test_for_bad_char(p_source+index,delta,p_reserved_chars))
            {
                if (good_byte_count > 0) {p_out->write(p_inputtype,p_source+index-good_byte_count,good_byte_count);good_byte_count=0;}
                p_out->write(p_inputtype,"_",1);
            }
            else
            {
                good_byte_count += delta;
            }
            index += delta;
        }
        if (good_byte_count > 0) {p_out->write(p_inputtype,p_source+index-good_byte_count,good_byte_count);good_byte_count=0;}
    }
}

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

Definition at line 61 of file titleformat.cpp.

{
    p_out.reset();
    remove_forbidden_chars_string_append(p_out,p_source,p_source_len,p_reserved_chars);
}

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

Definition at line 56 of file titleformat.cpp.

{
    remove_forbidden_chars(&titleformat_text_out_impl_string(p_out),pfc::guid_null,p_source,p_source_len,p_reserved_chars);
}

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

Helper;.

Definition at line 149 of file titleformat.cpp.

{
    service_ptr_t<titleformat_object> ptr;
    if (!compile(ptr,p_spec)) p_out = "[COMPILATION ERROR]";
    else ptr->run(p_source,p_out,NULL);
}

---

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

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