cfg_var_writer

#include <cfg_var.h>

Inheritance diagram for cfg_var_writer:

Public Member Functions
	cfg_var_writer (const GUID &guid)
	~cfg_var_writer ()
virtual void	get_data_raw (stream_writer *p_stream, abort_callback &p_abort)=0

Static Public Member Functions
static void	config_write_file (stream_writer *p_stream, abort_callback &p_abort)

Data Fields
const GUID	m_guid

Private Attributes
cfg_var_writer *	m_next

Static Private Attributes
static cfg_var_writer *	g_list = NULL

Detailed Description

Writer part of cfg_var object. In most cases, you should use cfg_var instead of using cfg_var_writer directly.

Definition at line 31 of file cfg_var.h.

Constructor & Destructor Documentation

cfg_var_writer::cfg_var_writer ( const GUID &  guid )

inline

Parameters

p_guid

GUID of the variable, used to identify variable implementations owning specific configuration file entries when reading the configuration file back. You must generate a new GUID every time you declare a new cfg_var.

Definition at line 34 of file cfg_var.h.

: m_guid(guid) { CFG_VAR_ASSERT_SAFEINIT; m_next = g_list; g_list = this;}

cfg_var_writer::~cfg_var_writer ( )

inline

Definition at line 35 of file cfg_var.h.

{ CFG_VAR_ASSERT_SAFEINIT; }

Member Function Documentation

void cfg_var_writer::config_write_file ( stream_writer *  p_stream, abort_callback &  p_abort  )

static

For internal use only, do not call.

Definition at line 34 of file cfg_var.cpp.

                                                                                        {
    cfg_var_writer * ptr;
    pfc::array_t<t_uint8,pfc::alloc_fast_aggressive> temp;
    for(ptr = g_list; ptr; ptr = ptr->m_next) {
        temp.set_size(0);
        {
            stream_writer_buffer_append_ref_t<pfc::array_t<t_uint8,pfc::alloc_fast_aggressive> > stream(temp);
            ptr->get_data_raw(&stream,p_abort);
        }
        p_stream->write_lendian_t(ptr->m_guid,p_abort);
        p_stream->write_lendian_t(pfc::downcast_guarded<t_uint32>(temp.get_size()),p_abort);
        if (temp.get_size() > 0) {
            p_stream->write_object(temp.get_ptr(),temp.get_size(),p_abort);
        }
    }
}

virtual void cfg_var_writer::get_data_raw ( stream_writer *  p_stream, abort_callback &  p_abort  )

pure virtual

Retrieves state of the variable. Called only from main thread, when writing configuration file.

Parameters

p_stream

Stream receiving state of the variable.

Implemented in cfg_dsp_chain_config, cfgDialogPosition, cfg_objMap< TMap >, cfg_obj< TObj >, cfg_objListEx< TList >, cfg_objList< TObj >, cfg_struct_t< t_struct >, cfg_string_mt, cfg_string, config_object_fixed_impl_t< p_size >, cfg_int_t< t_inttype >, cfg_int_t< t_uint64 >, cfg_int_t< bool >, cfgWindowSize, config_object_impl, cfg_window_size, cfg_window_placement, and cfg_guidlist.

Field Documentation

cfg_var_writer * cfg_var_writer::g_list = NULL

staticprivate

Definition at line 46 of file cfg_var.h.

const GUID cfg_var_writer::m_guid

Definition at line 44 of file cfg_var.h.

cfg_var_writer* cfg_var_writer::m_next

private

Definition at line 47 of file cfg_var.h.

---

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

• foobar2000/SDK/cfg_var.h
• foobar2000/SDK/cfg_var.cpp