tConfItemBase Class Reference

#include <tConfiguration.h>

Inheritance diagram for tConfItemBase:

[legend]

Collaboration diagram for tConfItemBase:

[legend]

List of all members.

Public Member Functions
typedef void	callbackFunc (void)
	tConfItemBase (const char *title, const tOutput &help, callbackFunc *cb=0)
	tConfItemBase (const char *title, callbackFunc *cb=0)
virtual	~tConfItemBase ()
tString const &	GetTitle () const
virtual void	ReadVal (std::istream &s)=0
virtual void	WriteVal (std::ostream &s)=0
virtual void	WasChanged ()
virtual bool	Writable ()
virtual bool	Save ()
Static Public Member Functions
static int	EatWhitespace (std::istream &s)
static void	SaveAll (std::ostream &s)
static void	LoadAll (std::istream &s)
static void	LoadLine (std::istream &s)
	loads configuration from file
static bool	LoadPlayback (bool print=false)
	loads one configuration line
static void	DocAll (std::ostream &s)
	loads configuration from playback
static std::deque< tString >	GetCommands (void)
static tConfItemBase *	FindConfigItem (tString const &name)
Static Public Attributes
static bool	printChange = true
	if set, setting changes are printed to the console and, if printErrors is set as well, suggestions of typo fixes are given.
static bool	printErrors = true
	if set, unknown settings are pointed out.
Protected Types
typedef std::map< tString, tConfItemBase * >	tConfItemMap
Protected Member Functions
void	ExecuteCallback ()
Static Protected Member Functions
static tConfItemMap &	ConfItemMap ()
Protected Attributes
const tString	title
const tOutput	help
bool	changed
tAccessLevel	requiredLevel
Private Attributes
int	id
callbackFunc *	callback
Friends
class	tCheckedPTRBase
class	tConfItemLevel
class	tAccessLevelSetter

---

Detailed Description

Definition at line 102 of file tConfiguration.h.

---

Member Typedef Documentation

typedef std::map< tString, tConfItemBase * > tConfItemBase::tConfItemMap [protected]

Definition at line 115 of file tConfiguration.h.

---

Constructor & Destructor Documentation

tConfItemBase::tConfItemBase	(	const char *	title,
		const tOutput &	help,
		callbackFunc *	cb = 0
	)

Definition at line 286 of file tConfiguration.cpp.

References ConfItemMap(), requiredLevel, tAccessLevel_Admin, tERR_ERROR_INT, and title.

        :id(-1),title(t), help(h),
changed(false),callback(cb){

    tConfItemMap & confmap = ConfItemMap();
    if ( confmap.find( title ) != confmap.end() )
        tERR_ERROR_INT("Two tConfItems with the same name " << t << "!");

    confmap[title] = this;

    requiredLevel = tAccessLevel_Admin;
}

Here is the call graph for this function:

tConfItemBase::tConfItemBase	(	const char *	title,
		callbackFunc *	cb = 0
	)

Definition at line 266 of file tConfiguration.cpp.

References ConfItemMap(), help, requiredLevel, tAccessLevel_Admin, tERR_ERROR_INT, title, and tToLower().

        :id(-1),title(t),
changed(false),callback(cb){

    tConfItemMap & confmap = ConfItemMap();
    if ( confmap.find( title ) != confmap.end() )
        tERR_ERROR_INT("Two tConfItems with the same name " << t << "!");

    // compose help name
    tString helpname;
    helpname << title << "_help";
    tToLower( helpname );

    const_cast<tOutput&>(help).AddLocale(helpname);

    confmap[title] = this;

    requiredLevel = tAccessLevel_Admin;
}

Here is the call graph for this function:

tConfItemBase::~tConfItemBase

(

)

[virtual]

Definition at line 299 of file tConfiguration.cpp.

References ConfItemMap(), st_confMap, and title.

{
    tConfItemMap & confmap = ConfItemMap();
    confmap.erase(title);
    if ( confmap.size() == 0 )
    {
        delete st_confMap;
        st_confMap = 0;
    }
}

Here is the call graph for this function:

---

Member Function Documentation

tConfItemBase::tConfItemMap & tConfItemBase::ConfItemMap

(

)

[static, protected]

Definition at line 107 of file tConfiguration.cpp.

References st_confMap, and tNEW.

Referenced by DocAll(), FindConfigItem(), GetCommands(), LoadLine(), nConfItemBase::s_GetConfigMessage(), nConfItemBase::s_RevertToDefaults(), nConfItemBase::s_RevertToSavedValues(), nConfItemBase::s_SaveValues(), nConfItemBase::s_SendConfig(), SaveAll(), tConfItemBase(), and ~tConfItemBase().

{
    if (!st_confMap)
        st_confMap = tNEW( tConfItemMap );
    return *st_confMap;
}

Here is the caller graph for this function:

typedef void tConfItemBase::callbackFunc

(

void

)

Referenced by _wrap_new_TConfItemBase__SWIG_0().

Here is the caller graph for this function:

void tConfItemBase::ExecuteCallback

(

)

[inline, protected]

Definition at line 123 of file tConfiguration.h.

References callback.

Referenced by nConfItem< tString >::NetReadVal(), tConfItem< nConfigItemBehavior >::ReadVal(), tConfItemLine::ReadVal(), and nConfItemLine::ReadVal().

{if (callback != 0) (*callback)(); }

Here is the caller graph for this function:

tString const& tConfItemBase::GetTitle

(

)

const [inline]

Definition at line 135 of file tConfiguration.h.

References title.

Referenced by nConfItemVersionWatcher::FillTemplateParameters().

                                     {
        return title;
    }

Here is the caller graph for this function:

int tConfItemBase::EatWhitespace

(

std::istream &

s

)

[static]

Definition at line 323 of file tConfiguration.cpp.

References c, and isblank().

Referenced by tConfItem< nConfigItemBehavior >::ReadVal().

                                             {
    int c=' ';

    while(isblank(c) &&
            c!='\n'    &&
            s.good()  &&
            !s.eof())
        c=s.get();

    s.putback(c);

    return c;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tConfItemBase::SaveAll

(

std::ostream &

s

)

[static]

Definition at line 310 of file tConfiguration.cpp.

References ConfItemMap(), Save(), title, and WriteVal().

Referenced by st_SaveConfig().

                                        {
    tConfItemMap & confmap = ConfItemMap();
    for(tConfItemMap::iterator iter = confmap.begin(); iter != confmap.end() ; ++iter)
    {
        tConfItemBase * ci = (*iter).second;
        if (ci->Save()){
            s << std::setw(28) << ci->title << " ";
            ci->WriteVal(s);
            s << '\n';
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tConfItemBase::LoadAll

(

std::istream &

s

)

[static]

concatenate lines ending in a backslash

Definition at line 571 of file tConfiguration.cpp.

References con, tException::GetDescription(), tRecorderBase::IsPlayingBack(), tString::Len(), LoadLine(), tString::ReadLine(), tRecorder::Record(), s_VetoPlayback(), s_VetoRecording(), tString::Size(), tString::StartsWith(), and tString::SubStr().

Referenced by _wrap_TConfItemBase_load_all(), zEffectorSetting::effect(), gMemuItemConsole::Event(), Load(), gParser::parseSetting(), RInclude(), sr_Read_stdin(), gGame::StateUpdate(), and tConfItemBase_LoadString().

                                        {
    tCurrentAccessLevel levelResetter;

    try{

    while(!s.eof() && s.good())
    {
        tString line;

        // read line from stream
        line.ReadLine( s );

        while ( line.Size() > 0 && line[line.Size()-1] == '\\' && s.good() && !s.eof() )
        {
            line = line.SubStr( 0, line.Size()-1 );

            // unless it is a double backslash
            if ( line.Size() > 0 && line[line.Size()-1] == '\\' )
            {
                break;
            }

            tString rest;
            rest.ReadLine( s );
            line << rest;
        }

        if ( line.Len() <= 1 )
            continue;

        // write line to recording
        if ( !s_VetoRecording( line ) )
        {
            // don't record supid admins' instant chat logins
            static tString instantChat("INSTANT_CHAT_STRING");
            if ( line.StartsWith( instantChat ) && strstr( line, "/login" ) )
            {
                tString newLine = line.SubStr( 0, strstr( line, "/login" ) - (char const *)line );
                newLine += "/login NONE";
                if ( line[strlen(line)-1] == '\\' )
                    newLine += '\\';
                tRecorder::Record( recordingSection, newLine );
            }
            else
                tRecorder::Record( recordingSection, line );
        }

        //        std::cout << line << '\n';

        // process line
        // line << '\n';
        if ( !tRecorder::IsPlayingBack() || s_VetoPlayback( line ) )
        {
            std::stringstream str(static_cast< char const * >( line ) );
            tConfItemBase::LoadLine(str);
            // std::cout << line << '\n';
        }
    }
    }
    catch( tAbortLoading const & e )
    {
        // loading was aborted
        con << e.GetDescription() << "\n";
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tConfItemBase::LoadLine

(

std::istream &

s

)

[static]

loads configuration from file

Definition at line 337 of file tConfiguration.cpp.

References c, changed, con, ConfItemMap(), tCurrentAccessLevel::GetAccessLevel(), tCurrentAccessLevel::GetName(), help, printChange, printErrors, tString::ReadLine(), ReadVal(), requiredLevel, tString::SetPos(), tOutput::SetTemplateParameter(), title, tToUpper(), and WasChanged().

Referenced by _wrap_TConfItemBase_load_line(), LoadAll(), and LoadPlayback().

                                         {
    if(!s.eof() && s.good()){
        tString name;
        s >> name;

        // make name uppercase:
        tToUpper( name );

        bool found=false;

        if (name.Size()==0) // ignore empty lines
            found=true;
        else if (name[0]=='#'){ // comment. ignore rest of line
            char c=' ';
            while(c!='\n' && s.good() && !s.eof()) c=s.get();
            found=true;
        }

        tConfItemMap & confmap = ConfItemMap();
        tConfItemMap::iterator iter = confmap.find( name );
        if ( iter != confmap.end() )
        {
            tConfItemBase * ci = (*iter).second;

            bool cb=ci->changed;
            ci->changed=false;

            if ( ci->requiredLevel >= tCurrentAccessLevel::GetAccessLevel() )
            {
                ci->ReadVal(s);
                if (ci->changed)
                    ci->WasChanged();
                else
                    ci->changed=cb;
            }
            else
            {
                tString discard;
                discard.ReadLine(s);
                
                con << tOutput( "$access_level_error",
                                name,  
                                tCurrentAccessLevel::GetName( ci->requiredLevel ),
                                tCurrentAccessLevel::GetName( tCurrentAccessLevel::GetAccessLevel() )
                    );
                return;
            }

            found=true;
        }

        if (!found){
            // eat rest of input line
            tString rest;
            rest.ReadLine( s );
#ifdef MACOSX
            printErrors = false;
#endif
            if (printErrors)
            {
                tOutput o;
                o.SetTemplateParameter(1, name);
                o << "$config_command_unknown";
                con << o;

                if (printChange)
                {
                    int sim_maxlen=-1;

                    for(tConfItemMap::iterator iter = confmap.begin(); iter != confmap.end() ; ++iter)
                    {
                        tConfItemBase * ci = (*iter).second;
                        if (strstr(ci->title,name) &&
                                static_cast<int>(strlen(ci->title)) > sim_maxlen)
                            sim_maxlen=strlen(ci->title);
                    }

                    if (sim_maxlen>0 && printChange ){
                        int len = name.Len()-1;
                        int printMax = 1 + 3 * len * len * len;
                        con << tOutput("$config_command_other");
                        for(tConfItemMap::iterator iter = confmap.begin(); iter != confmap.end() ; ++iter)
                        {
                            tConfItemBase * ci = (*iter).second;
                            if (strstr(ci->title,name))
                            {
                                tString help ( ci->help );
                                if ( --printMax > 0 )
                                {
                                    tString mess;
                                    mess << ci->title;
                                    mess.SetPos( sim_maxlen+2, false );
                                    mess << "(";
                                    mess << help;
                                    mess << ")\n";
                                    con << mess;
                                }
                            }
                        }
                        if (printMax <= 0 )
                            con << tOutput("$config_command_more");
                    }
                }
                else
                {
                    con << '\n';
                }
            }
        }
    }

    //  std::cout << line << " lines read.\n";
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tConfItemBase::LoadPlayback

(

bool

print = false

)

[static]

loads one configuration line

Definition at line 702 of file tConfiguration.cpp.

References con, tRecorderBase::IsPlayingBack(), LoadLine(), tRecorder::Playback(), tRecorder::Record(), and s_VetoPlayback().

Referenced by gMemuItemConsole::Event(), gParser::parseSetting(), sr_Read_stdin(), st_LoadConfig(), and gGame::StateUpdate().

{
    if ( !tRecorder::IsPlayingBack() )
        return false;

    // read line from recording
    tString line;
    while ( tRecorder::Playback( recordingSection, line ) )
    {
        tRecorder::Record( recordingSection, line );
        if ( !s_VetoPlayback( line ) )
        {
            // process line
            if ( print ) con << "Playback input : " << line << '\n';
            std::stringstream str(static_cast< char const * >( line ) );
            tConfItemBase::LoadLine(str);
        }
    }

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tConfItemBase::DocAll

(

std::ostream &

s

)

[static]

loads configuration from playback

Definition at line 638 of file tConfiguration.cpp.

References ConfItemMap(), help, tString::SetPos(), and title.

Referenced by tCommandLineData::Execute().

                                       {
    tConfItemMap & confmap = ConfItemMap();
    for(tConfItemMap::iterator iter = confmap.begin(); iter != confmap.end() ; ++iter)
    {
        tConfItemBase * ci = (*iter).second;

        tString help ( ci->help );
        if ( help != "UNDOCUMENTED" )
        {
            tString line;
            line << ci->title;
            line.SetPos( 30, false );
            line << help;
            s << line << '\n';
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::deque< tString > tConfItemBase::GetCommands

(

void

)

[static]

Definition at line 656 of file tConfiguration.cpp.

References ConfItemMap(), title, and tString::ToLower().

Referenced by do_con().

                                            {
    std::deque<tString> ret;
    tConfItemMap & confmap = ConfItemMap();
    for(tConfItemMap::iterator iter = confmap.begin(); iter != confmap.end() ; ++iter)
    {
        tConfItemBase * ci = (*iter).second;

        ret.push_back(ci->title.ToLower());
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

tConfItemBase * tConfItemBase::FindConfigItem

(

tString const &

name

)

[static]

Definition at line 667 of file tConfiguration.cpp.

References ConfItemMap(), and tString::ToUpper().

Referenced by _wrap_TConfItemBase_find_config_item(), and gAutoCompleterConsole::Complete().

                                                                {
    tConfItemMap & confmap = ConfItemMap();
    tConfItemMap::iterator iter = confmap.find( name.ToUpper() );
    if ( iter != confmap.end() ) {
        return iter->second;
    } else {
        return 0;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void tConfItemBase::ReadVal

(

std::istream &

s

)

[pure virtual]

Implemented in tConfItemPassword, nConfItemLine, SwigDirector_TConfItemBase, tConfItem< T >, tConfItemLine, tConfItemFunc, tSettingRotation, tConfItem_key, tConfItem< float >, tConfItem< tString >, tConfItem< int >, and tConfItem< nConfigItemBehavior >.

Referenced by LoadLine().

Here is the caller graph for this function:

virtual void tConfItemBase::WriteVal

(

std::ostream &

s

)

[pure virtual]

Implemented in tConfItemPassword, SwigDirector_TConfItemBase, tConfItem< T >, tConfItemLine, tConfItemFunc, tSettingRotation, tConfItem_key, tConfItem< float >, tConfItem< tString >, tConfItem< int >, and tConfItem< nConfigItemBehavior >.

Referenced by gAutoCompleterConsole::Complete(), vValue::Expr::Bindings::Legacy::ConfItem::Read(), and SaveAll().

Here is the caller graph for this function:

virtual void tConfItemBase::WasChanged

(

)

[inline, virtual]

Reimplemented in nConfItem< T >, and nConfItem< tString >.

Definition at line 152 of file tConfiguration.h.

Referenced by LoadLine(), and nConfItem< tString >::WasChanged().

{} // what to do if a read changed the thing

Here is the caller graph for this function:

virtual bool tConfItemBase::Writable

(

void

)

[inline, virtual]

Reimplemented in nConfItemBase, and tSettingRotation.

Definition at line 154 of file tConfiguration.h.

Referenced by tConfItem< nConfigItemBehavior >::ReadVal().

                           {
        return true;
    }

Here is the caller graph for this function:

virtual bool tConfItemBase::Save

(

)

[inline, virtual]

Reimplemented in nSettingItem< T >, tSettingItem< T >, tConfItemFunc, tSettingRotation, tSettingItem< float >, and tSettingItem< nConfigItemBehavior >.

Definition at line 158 of file tConfiguration.h.

Referenced by SaveAll().

                       {
        return true;
    }

Here is the caller graph for this function:

---

Friends And Related Function Documentation

friend class tCheckedPTRBase [friend]

Definition at line 104 of file tConfiguration.h.

friend class tConfItemLevel [friend]

Definition at line 105 of file tConfiguration.h.

friend class tAccessLevelSetter [friend]

Definition at line 106 of file tConfiguration.h.

---

Member Data Documentation

int tConfItemBase::id [private]

Definition at line 108 of file tConfiguration.h.

const tString tConfItemBase::title [protected]

Definition at line 110 of file tConfiguration.h.

Referenced by DocAll(), GetCommands(), GetTitle(), LoadLine(), nConfItem< tString >::NetReadVal(), tConfItem< nConfigItemBehavior >::ReadVal(), tConfItemLine::ReadVal(), nConfItemLine::ReadVal(), SaveAll(), nConfItemBase::SendConfig(), tConfItemBase(), and ~tConfItemBase().

const tOutput tConfItemBase::help [protected]

Definition at line 111 of file tConfiguration.h.

Referenced by DocAll(), LoadLine(), and tConfItemBase().

bool tConfItemBase::changed [protected]

Definition at line 112 of file tConfiguration.h.

Referenced by LoadLine(), nConfItem< tString >::NetReadVal(), tConfItem< nConfigItemBehavior >::ReadVal(), tConfItemLine::ReadVal(), nConfItemLine::ReadVal(), nConfItemBase::SendConfig(), and nConfItem< tString >::Set().

tAccessLevel tConfItemBase::requiredLevel [protected]

Definition at line 113 of file tConfiguration.h.

Referenced by LoadLine(), tAccessLevelSetter::tAccessLevelSetter(), and tConfItemBase().

callbackFunc* tConfItemBase::callback [private]

Definition at line 121 of file tConfiguration.h.

Referenced by ExecuteCallback().

bool tConfItemBase::printChange = true [static]

if set, setting changes are printed to the console and, if printErrors is set as well, suggestions of typo fixes are given.

Definition at line 128 of file tConfiguration.h.

Referenced by LoadLine(), nConfItem< tString >::NetReadVal(), tConfItem< nConfigItemBehavior >::ReadVal(), tConfItemLine::ReadVal(), nConfItemLine::ReadVal(), and st_LoadConfig().

bool tConfItemBase::printErrors = true [static]

if set, unknown settings are pointed out.

Definition at line 129 of file tConfiguration.h.

Referenced by LoadLine(), and st_LoadConfig().

---

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

• src/tools/tConfiguration.h
• src/tools/tConfiguration.cpp

---