w11 - cpp 0.794
Backend server for Rlink and w11
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Retro::RtclClassBase Class Referenceabstract

FIXME_docs. More...

#include <RtclClassBase.hpp>

Inheritance diagram for Retro::RtclClassBase:
[legend]
Collaboration diagram for Retro::RtclClassBase:
[legend]

Public Member Functions

 RtclClassBase (const std::string &type=std::string())
 Default constructor.
 
virtual ~RtclClassBase ()
 Destructor.
 
 RtclClassBase (const RtclClassBase &)=delete
 
RtclClassBase & operator= (const RtclClassBase &)=delete
 
const std::string & Type () const
 FIXME_docs.
 
Tcl_Command Token () const
 FIXME_docs.
 

Static Public Attributes

static const int kOK = TCL_OK
 
static const int kERR = TCL_ERROR
 

Protected Member Functions

void SetType (const std::string &type)
 FIXME_docs.
 
void CreateClassCmd (Tcl_Interp *interp, const char *name)
 FIXME_docs.
 
virtual int TclClassCmd (Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 FIXME_docs.
 
virtual int ClassCmdList (Tcl_Interp *interp)
 FIXME_docs.
 
virtual int ClassCmdDelete (Tcl_Interp *interp, const char *name)
 FIXME_docs.
 
virtual int ClassCmdCreate (Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])=0
 

Static Protected Member Functions

static int ThunkTclClassCmd (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 FIXME_docs.
 
static void ThunkTclCmdDeleteProc (ClientData cdata)
 FIXME_docs.
 
static void ThunkTclExitProc (ClientData cdata)
 FIXME_docs.
 

Protected Attributes

std::string fType
 classed type name
 
Tcl_Interp * fInterp
 tcl interpreter
 
Tcl_Command fCmdToken
 cmd token for class command
 

Detailed Description

FIXME_docs.

Definition at line 24 of file RtclClassBase.hpp.

Constructor & Destructor Documentation

◆ RtclClassBase() [1/2]

Retro::RtclClassBase::RtclClassBase ( const std::string &  type = std::string())
explicit

Default constructor.

Definition at line 49 of file RtclClassBase.cpp.

◆ ~RtclClassBase()

Retro::RtclClassBase::~RtclClassBase ( )
virtual

Destructor.

Definition at line 58 of file RtclClassBase.cpp.

References Retro::RtclContext::Find(), fInterp, and Retro::RtclContext::UnRegisterClass().

◆ RtclClassBase() [2/2]

Retro::RtclClassBase::RtclClassBase ( const RtclClassBase &  )
delete

Member Function Documentation

◆ operator=()

RtclClassBase & Retro::RtclClassBase::operator= ( const RtclClassBase &  )
delete

◆ Type()

const std::string & Retro::RtclClassBase::Type ( ) const
inline

FIXME_docs.

Definition at line 21 of file RtclClassBase.ipp.

References fType.

Referenced by ClassCmdDelete(), and ClassCmdList().

◆ Token()

Tcl_Command Retro::RtclClassBase::Token ( ) const
inline

FIXME_docs.

Definition at line 29 of file RtclClassBase.ipp.

References fCmdToken.

Referenced by ClassCmdList().

◆ SetType()

void Retro::RtclClassBase::SetType ( const std::string &  type)
inlineprotected

FIXME_docs.

Definition at line 37 of file RtclClassBase.ipp.

References fType.

◆ CreateClassCmd()

void Retro::RtclClassBase::CreateClassCmd ( Tcl_Interp *  interp,
const char *  name 
)
protected

FIXME_docs.

Definition at line 66 of file RtclClassBase.cpp.

References fCmdToken, Retro::RtclContext::Find(), fInterp, Retro::RtclContext::RegisterClass(), ThunkTclClassCmd(), ThunkTclCmdDeleteProc(), and ThunkTclExitProc().

Referenced by Retro::RtclClassOwned< TP >::CreateClass().

◆ TclClassCmd()

int Retro::RtclClassBase::TclClassCmd ( Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
protectedvirtual

FIXME_docs.

Definition at line 82 of file RtclClassBase.cpp.

References ClassCmdCreate(), ClassCmdDelete(), ClassCmdList(), Retro::RtclContext::Find(), Retro::RtclContext::FindProxy(), kERR, and Retro::RtclProxyBase::Type().

Referenced by ThunkTclClassCmd().

◆ ClassCmdList()

int Retro::RtclClassBase::ClassCmdList ( Tcl_Interp *  interp)
protectedvirtual

FIXME_docs.

Definition at line 113 of file RtclClassBase.cpp.

References Retro::RtclContext::Find(), kERR, kOK, Retro::RtclContext::ListProxy(), Token(), and Type().

Referenced by TclClassCmd().

◆ ClassCmdDelete()

int Retro::RtclClassBase::ClassCmdDelete ( Tcl_Interp *  interp,
const char *  name 
)
protectedvirtual

FIXME_docs.

Definition at line 133 of file RtclClassBase.cpp.

References Retro::RtclContext::CheckProxy(), Retro::RtclContext::Find(), kERR, kOK, and Type().

Referenced by TclClassCmd().

◆ ClassCmdCreate()

virtual int Retro::RtclClassBase::ClassCmdCreate ( Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
protectedpure virtual

Implemented in Retro::RtclClassOwned< TP >.

Referenced by TclClassCmd().

◆ ThunkTclClassCmd()

int Retro::RtclClassBase::ThunkTclClassCmd ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
staticprotected

FIXME_docs.

Definition at line 164 of file RtclClassBase.cpp.

References Retro::Rtcl::AppendResultNewLines(), kERR, and TclClassCmd().

Referenced by CreateClassCmd().

◆ ThunkTclCmdDeleteProc()

void Retro::RtclClassBase::ThunkTclCmdDeleteProc ( ClientData  cdata)
staticprotected

FIXME_docs.

Definition at line 187 of file RtclClassBase.cpp.

References ThunkTclExitProc().

Referenced by CreateClassCmd().

◆ ThunkTclExitProc()

void Retro::RtclClassBase::ThunkTclExitProc ( ClientData  cdata)
staticprotected

FIXME_docs.

Definition at line 198 of file RtclClassBase.cpp.

Referenced by CreateClassCmd(), and ThunkTclCmdDeleteProc().

Member Data Documentation

◆ kOK

const int Retro::RtclClassBase::kOK = TCL_OK
static

Definition at line 37 of file RtclClassBase.hpp.

Referenced by ClassCmdDelete(), and ClassCmdList().

◆ kERR

const int Retro::RtclClassBase::kERR = TCL_ERROR
static

Definition at line 38 of file RtclClassBase.hpp.

Referenced by ClassCmdDelete(), ClassCmdList(), TclClassCmd(), and ThunkTclClassCmd().

◆ fType

std::string Retro::RtclClassBase::fType
protected

classed type name

Definition at line 60 of file RtclClassBase.hpp.

Referenced by SetType(), and Type().

◆ fInterp

Tcl_Interp* Retro::RtclClassBase::fInterp
protected

tcl interpreter

Definition at line 61 of file RtclClassBase.hpp.

Referenced by CreateClassCmd(), and ~RtclClassBase().

◆ fCmdToken

Tcl_Command Retro::RtclClassBase::fCmdToken
protected

cmd token for class command

Definition at line 62 of file RtclClassBase.hpp.

Referenced by CreateClassCmd(), and Token().

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