LcConfigC_Misc_CC_API

LcConfigC - various functions to perform misc operations … More...

Collaboration diagram for LcConfigC_Misc_CC_API:

Functions
LcSettingC *	cclcconfig::LcConfigC::RootSetting () const
	C++: LcSettingC* config.RootSetting() → C-API This function, which is implemented as a macro, returns the root setting for the configuration config …
void	cclcconfig::LcConfigC::Clear ()
	C++: config.Clear() → C-API Since v1.7 This function clears the configuration config …
void	cclcconfig::LcConfigC::Log (const MkObjectC *fmtobj=NULL, MK_DBG debug=0, MK_STRN callfunc=__builtin_FUNCTION(), MK_I32 lvl=0) const
	C++: cfg.Log(const MkObjectC* fmtobj = NULL, MK_DBG debug = 0, MK_STRN callfunc = __builtin_FUNCTION(), MK_I32 lvl = 0) → C-API log the config …
void	cclcconfig::LcConfigC::Log (const MkObjectC &fmtobj, MK_DBG debug=0, MK_STRN callfunc=__builtin_FUNCTION(), MK_I32 lvl=0) const
	C++: cfg.Log(const MkObjectC* fmtobj = NULL, MK_DBG debug = 0, MK_STRN callfunc = __builtin_FUNCTION(), MK_I32 lvl = 0) → C-API log the config …
void	cclcconfig::LcConfigC::ReadFile (MK_STRN filename)
	C++: config.ReadFile(MK_STRN filename) → C-API This function reads and parses a configuration from the file named filename into the configuration object config …
void	cclcconfig::LcConfigC::ReadFile (const std::string &filename)
	C++: config.ReadFile(MK_STRN filename) → C-API This function reads and parses a configuration from the file named filename into the configuration object config …
void	cclcconfig::LcConfigC::ReadString (MK_STRN str)
	C++: config.ReadString(MK_STRN str) → C-API This function reads and parses a configuration from the string str into the configuration object config …
void	cclcconfig::LcConfigC::ReadString (const std::string &str)
	C++: config.ReadString(MK_STRN str) → C-API This function reads and parses a configuration from the string str into the configuration object config …
void	cclcconfig::LcConfigC::WriteFile (MK_STRN filename)
	C++: config.WriteFile(MK_STRN filename) → C-API This function writes the configuration config to the file named filename …
void	cclcconfig::LcConfigC::WriteFile (const std::string &filename)
	C++: config.WriteFile(MK_STRN filename) → C-API This function writes the configuration config to the file named filename …
MK_STRN	cclcconfig::LcConfigC::WriteString () const
	C++: MK_STRN cfg.WriteString() → C-API read the entire configuration cfg into the string val_out …

Detailed Description

LcConfigC - various functions to perform misc operations …

Function Documentation

Clear()

void cclcconfig::LcConfigC::Clear ( )

inline

C++: config.Clear() → C-API
Since v1.7 This function clears the configuration config …

Definition at line 306 of file LcConfigC_inline_cc.hh.

                                 {
    MK_UNUSED auto config = getCFG();
    LcConfigClear(config);
  }

Log() [1/2]

void cclcconfig::LcConfigC::Log ( const MkObjectC & fmtobj, MK_DBG debug = 0, MK_STRN callfunc = __builtin_FUNCTION(), MK_I32 lvl = 0 ) const

inline

C++: cfg.Log(const MkObjectC* fmtobj = NULL, MK_DBG debug = 0, MK_STRN callfunc = __builtin_FUNCTION(), MK_I32 lvl = 0) → C-API
log the config …

Definition at line 321 of file LcConfigC_inline_cc.hh.

                                                                                                       {
    MK_UNUSED auto cfg = getCFGN();
    const MK_OBJN fmtobj_hdl = MkObjectC::getOBJN(fmtobj);
    if (callfunc == NULL) {callfunc = __builtin_FUNCTION();}
    if (debug > (MK_DBG)(MkRuntimeDebugGet())) {return;}
    LcConfigLog(cfg, fmtobj_hdl, debug, callfunc, lvl);
  }

Log() [2/2]

void cclcconfig::LcConfigC::Log ( const MkObjectC * fmtobj = NULL, MK_DBG debug = 0, MK_STRN callfunc = __builtin_FUNCTION(), MK_I32 lvl = 0 ) const

inline

C++: cfg.Log(const MkObjectC* fmtobj = NULL, MK_DBG debug = 0, MK_STRN callfunc = __builtin_FUNCTION(), MK_I32 lvl = 0) → C-API
log the config …

Definition at line 312 of file LcConfigC_inline_cc.hh.

                                                                                                       {
    MK_UNUSED auto cfg = getCFGN();
    MK_OBJN fmtobj_hdl = MkObjectC::getOBJN__null_allow(fmtobj);
    if (callfunc == NULL) {callfunc = __builtin_FUNCTION();}
    if (debug > (MK_DBG)(MkRuntimeDebugGet())) {return;}
    LcConfigLog(cfg, fmtobj_hdl, debug, callfunc, lvl);
  }

ReadFile() [1/2]

void cclcconfig::LcConfigC::ReadFile ( const std::string & filename )

inline

C++: config.ReadFile(MK_STRN filename) → C-API
This function reads and parses a configuration from the file named filename into the configuration object config …

Definition at line 337 of file LcConfigC_inline_cc.hh.

                                                             {
    MK_UNUSED auto config = getCFG();
    const MK_STRN filename_hdl = filename.c_str();
    enum MkErrorE errVal = LcConfigReadFile(config, filename_hdl);
    MkErrorC_Check(config, errVal);
  }

ReadFile() [2/2]

void cclcconfig::LcConfigC::ReadFile ( MK_STRN filename )

inline

C++: config.ReadFile(MK_STRN filename) → C-API
This function reads and parses a configuration from the file named filename into the configuration object config …

Definition at line 330 of file LcConfigC_inline_cc.hh.

                                                    {
    MK_UNUSED auto config = getCFG();
    enum MkErrorE errVal = LcConfigReadFile(config, filename);
    MkErrorC_Check(config, errVal);
  }

ReadString() [1/2]

void cclcconfig::LcConfigC::ReadString ( const std::string & str )

inline

C++: config.ReadString(MK_STRN str) → C-API
This function reads and parses a configuration from the string str into the configuration object config …

Definition at line 352 of file LcConfigC_inline_cc.hh.

                                                          {
    MK_UNUSED auto config = getCFG();
    const MK_STRN str_hdl = str.c_str();
    enum MkErrorE errVal = LcConfigReadString(config, str_hdl);
    MkErrorC_Check(config, errVal);
  }

ReadString() [2/2]

void cclcconfig::LcConfigC::ReadString ( MK_STRN str )

inline

C++: config.ReadString(MK_STRN str) → C-API
This function reads and parses a configuration from the string str into the configuration object config …

Definition at line 345 of file LcConfigC_inline_cc.hh.

                                                 {
    MK_UNUSED auto config = getCFG();
    enum MkErrorE errVal = LcConfigReadString(config, str);
    MkErrorC_Check(config, errVal);
  }

RootSetting()

LcSettingC * cclcconfig::LcConfigC::RootSetting ( ) const

inline

C++: LcSettingC* config.RootSetting() → C-API
This function, which is implemented as a macro, returns the root setting for the configuration config …

Definition at line 297 of file LcConfigC_inline_cc.hh.

                                                   {
    MK_UNUSED auto config = getCFGN();
    LC_CFS __retVal__L = LcConfigRootSetting(config);
    return LcSettingC::LcSettingC_ObjNew(MK_RT_CALL __retVal__L);
  }

WriteFile() [1/2]

void cclcconfig::LcConfigC::WriteFile ( const std::string & filename )

inline

C++: config.WriteFile(MK_STRN filename) → C-API
This function writes the configuration config to the file named filename …

Definition at line 367 of file LcConfigC_inline_cc.hh.

                                                              {
    MK_UNUSED auto config = getCFG();
    const MK_STRN filename_hdl = filename.c_str();
    enum MkErrorE errVal = LcConfigWriteFile(config, filename_hdl);
    MkErrorC_Check(config, errVal);
  }

WriteFile() [2/2]

void cclcconfig::LcConfigC::WriteFile ( MK_STRN filename )

inline

C++: config.WriteFile(MK_STRN filename) → C-API
This function writes the configuration config to the file named filename …

Definition at line 360 of file LcConfigC_inline_cc.hh.

                                                     {
    MK_UNUSED auto config = getCFG();
    enum MkErrorE errVal = LcConfigWriteFile(config, filename);
    MkErrorC_Check(config, errVal);
  }

WriteString()

MK_STRN cclcconfig::LcConfigC::WriteString ( ) const

inline

C++: MK_STRN cfg.WriteString() → C-API
read the entire configuration cfg into the string val_out …

Definition at line 377 of file LcConfigC_inline_cc.hh.

                                               {
    MK_UNUSED auto cfg = getCFGN();
    MK_STRN val_out;
    enum MkErrorE errVal = LcConfigWriteString(cfg, &val_out);
    MkErrorC_Check(cfg, errVal);
    return val_out;
  }