#include <config_object.h>

Inheritance diagram for config_object:

Public Member Functions
	FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (config_object)

virtual void	get_data (stream_writer *p_stream, abort_callback &p_abort) const =0

void	get_data_bool (bool &p_out)

bool	get_data_bool_simple (bool p_default)

void	get_data_int32 (t_int32 &p_out)

t_int32	get_data_int32_simple (t_int32 p_default)

t_size	get_data_raw (void *p_out, t_size p_bytes)

t_size	get_data_raw_length ()

void	get_data_string (pfc::string_base &p_out)

template<class T >
void	get_data_struct_t (T &p_out)

virtual GUID	get_guid () const =0

virtual void	set_data (stream_reader *p_stream, abort_callback &p_abort, bool p_sendnotify=true)=0

void	set_data_bool (bool p_val)

void	set_data_int32 (t_int32 p_val)

void	set_data_raw (const void *p_data, t_size p_bytes, bool p_sendnotify=true)

void	set_data_string (const char *p_data, t_size p_length)

template<class T >
void	set_data_struct_t (const T &p_in)

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 bool	g_find (service_ptr_t< config_object > &p_out, const GUID &p_guid)

static void	g_get_data_bool (const GUID &p_guid, bool &p_out)

static bool	g_get_data_bool_simple (const GUID &p_guid, bool p_default)

static void	g_get_data_int32 (const GUID &p_guid, t_int32 &p_out)

static t_int32	g_get_data_int32_simple (const GUID &p_guid, t_int32 p_default)

static void	g_get_data_string (const GUID &p_guid, pfc::string_base &p_out)

template<class T >
static void	g_get_data_struct_t (const GUID &p_guid, T &p_out)

static void	g_set_data_bool (const GUID &p_guid, bool p_val)

static void	g_set_data_int32 (const GUID &p_guid, t_int32 p_val)

static void	g_set_data_string (const GUID &p_guid, const char *p_data, t_size p_length=~0)

template<class T >
static void	g_set_data_struct_t (const GUID &p_guid, const T &p_in)

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

Definition at line 16 of file config_object.h.

Member Function Documentation

config_object::FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT ( config_object )

bool config_object::g_find	(	service_ptr_t< config_object > &	p_out,
		const GUID &	p_guid
	)

static

Definition at line 14 of file config_object.cpp.

 {
     service_ptr_t<config_object> ptr;
     service_enum_t<config_object> e;
     while(e.next(ptr))
     {
         if (ptr->get_guid() == p_guid)
         {
             p_out = ptr;
             return true;
         }
     }
     return false;
 }

void config_object::g_get_data_bool	(	const GUID &	p_guid,
		bool &	p_out
	)

static

Definition at line 103 of file config_object.cpp.

103 {g_get_data_struct_t<bool>(p_guid,p_out);}

bool config_object::g_get_data_bool_simple	(	const GUID &	p_guid,
		bool	p_default
	)

static

Definition at line 86 of file config_object.cpp.

 {
     service_ptr_t<config_object> ptr;
     if (!g_find(ptr,p_guid)) throw exception_service_not_found();
     return ptr->get_data_bool_simple(p_default);
 }

void config_object::g_get_data_int32	(	const GUID &	p_guid,
		t_int32 &	p_out
	)

static

Definition at line 74 of file config_object.cpp.

                                                                         {
     service_ptr_t<config_object> ptr;
     if (!g_find(ptr,p_guid)) throw exception_service_not_found();
     ptr->get_data_int32(p_out);
 }

t_int32 config_object::g_get_data_int32_simple	(	const GUID &	p_guid,
		t_int32	p_default
	)

static

Definition at line 93 of file config_object.cpp.

 {
     service_ptr_t<config_object> ptr;
     if (!g_find(ptr,p_guid)) throw exception_service_not_found();
     return ptr->get_data_int32_simple(p_default);
 }

void config_object::g_get_data_string	(	const GUID &	p_guid,
		pfc::string_base &	p_out
	)

static

Definition at line 29 of file config_object.cpp.

 {
     service_ptr_t<config_object> ptr;
     if (!g_find(ptr,p_guid)) throw exception_service_not_found();
     ptr->get_data_string(p_out);
 }

template<class T >

void config_object::g_get_data_struct_t	(	const GUID &	p_guid,
		T &	p_out
	)

static

Definition at line 17 of file config_object_impl.h.

                                                                      {
     service_ptr_t<config_object> ptr;
     if (!g_find(ptr,p_guid)) throw exception_service_not_found();
     return ptr->get_data_struct_t<T>(p_out);
 }

void config_object::g_set_data_bool	(	const GUID &	p_guid,
		bool	p_val
	)

static

Definition at line 104 of file config_object.cpp.

104 {g_set_data_struct_t<bool>(p_guid,p_val);}

void config_object::g_set_data_int32	(	const GUID &	p_guid,
		t_int32	p_val
	)

static

Definition at line 80 of file config_object.cpp.

                                                                       {
     service_ptr_t<config_object> ptr;
     if (!g_find(ptr,p_guid)) throw exception_service_not_found();
     ptr->set_data_int32(p_val);
 }

void config_object::g_set_data_string	(	const GUID &	p_guid,
		const char *	p_data,
		t_size	p_length = `~0`
	)

static

Definition at line 36 of file config_object.cpp.

 {
     service_ptr_t<config_object> ptr;
     if (!g_find(ptr,p_guid)) throw exception_service_not_found();
     ptr->set_data_string(p_data,p_length);
 }

template<class T >

void config_object::g_set_data_struct_t	(	const GUID &	p_guid,
		const T &	p_in
	)

static

Definition at line 24 of file config_object_impl.h.

                                                                           {
     service_ptr_t<config_object> ptr;
     if (!g_find(ptr,p_guid)) throw exception_service_not_found();
     return ptr->set_data_struct_t<T>(p_in);
 }

virtual void config_object::get_data	(	stream_writer *	p_stream,
		abort_callback &	p_abort
	)		const

pure virtual

Implemented in config_object_fixed_impl_t< p_size >, config_object_fixed_const_impl_t< p_size >, and config_object_impl.

void config_object::get_data_bool ( bool & p_out )

Definition at line 100 of file config_object.cpp.

100 {get_data_struct_t<bool>(p_out);}

bool config_object::get_data_bool_simple ( bool p_default )

Definition at line 58 of file config_object.cpp.

                                                        {
     try {
         bool ret = p_default;
         get_data_bool(ret);
         return ret;
     } catch(...) {return p_default;}
 }

void config_object::get_data_int32 ( t_int32 & p_out )

Definition at line 43 of file config_object.cpp.

 {
     t_int32 temp;
     get_data_struct_t<t_int32>(temp);
     byte_order::order_le_to_native_t(temp);
     p_out = temp;
 }

t_int32 config_object::get_data_int32_simple ( t_int32 p_default )

Definition at line 66 of file config_object.cpp.

                                                               {
     try {
         t_int32 ret = p_default;
         get_data_int32(ret);
         return ret;
     } catch(...) {return p_default;}
 }

t_size config_object::get_data_raw	(	void *	p_out,
		t_size	p_bytes
	)

Definition at line 146 of file config_object.cpp.

                                                               {
     t_size ret = 0;
     stream_writer_fixedbuffer stream(p_out,p_bytes,ret);
     abort_callback_dummy aborter;
     get_data(&stream,aborter);
     return ret;
 }

t_size config_object::get_data_raw_length ( )

Definition at line 154 of file config_object.cpp.

                                           {
     t_size ret = 0;
     stream_writer_get_length stream(ret);
     abort_callback_dummy aborter;
     get_data(&stream,aborter);
     return ret;
 }

void config_object::get_data_string ( pfc::string_base & p_out )

Definition at line 172 of file config_object.cpp.

                                                           {
     stream_writer_string stream(p_out);
     abort_callback_dummy aborter;
     get_data(&stream,aborter);
 }

template<class T >

void config_object::get_data_struct_t ( T & p_out )

Definition at line 7 of file config_object_impl.h.

                                               {
     if (get_data_raw(&p_out,sizeof(T)) != sizeof(T)) throw exception_io_data_truncation();
 }

virtual GUID config_object::get_guid ( ) const

pure virtual

Implemented in config_object_fixed_impl_t< p_size >, config_object_fixed_const_impl_t< p_size >, and config_object_impl.

virtual void config_object::set_data	(	stream_reader *	p_stream,
		abort_callback &	p_abort,
		bool	p_sendnotify = `true`
	)

pure virtual

Implemented in config_object_fixed_impl_t< p_size >, config_object_fixed_const_impl_t< p_size >, and config_object_impl.

void config_object::set_data_bool ( bool p_val )

Definition at line 101 of file config_object.cpp.

101 {set_data_struct_t<bool>(p_val);}

void config_object::set_data_int32 ( t_int32 p_val )

Definition at line 51 of file config_object.cpp.

 {
     t_int32 temp = p_val;
     byte_order::order_native_to_le_t(temp);
     set_data_struct_t<t_int32>(temp);
 }

void config_object::set_data_raw	(	const void *	p_data,
		t_size	p_bytes,
		bool	p_sendnotify = `true`
	)

Definition at line 162 of file config_object.cpp.

                                                                                   {
     stream_reader_memblock_ref stream(p_data,p_bytes);
     abort_callback_dummy aborter;
     set_data(&stream,aborter,p_notify);
 }

void config_object::set_data_string	(	const char *	p_data,
		t_size	p_length
	)

Definition at line 168 of file config_object.cpp.

                                                                        {
     set_data_raw(p_data,pfc::strlen_max(p_data,p_length));
 }

template<class T >

void config_object::set_data_struct_t ( const T & p_in )

Definition at line 12 of file config_object_impl.h.

                                                    {
     return set_data_raw(&p_in,sizeof(T));
 }

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

foobar2000/SDK/config_object.h
foobar2000/SDK/config_object.cpp
foobar2000/SDK/config_object_impl.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation