MkBufferStreamC_Read_TCL_API

MkBufferStreamC - various functions to 'read' data from a MkBufferStreamS … More...

Collaboration diagram for MkBufferStreamC_Read_TCL_API:

Functions
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadALL (MkBufferStreamC_ARGS)
	Tcl: MkBufferListC [$bus ReadALL ?val_inout:MkBufferListC="MK_NULL"?] → C-API get a temporary MkBufferListC from all data in the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadBFL (MkBufferStreamC_ARGS)
	Tcl: MkBufferListC [$bus ReadBFL] → C-API read a MkBufferListC from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadBUF (MkBufferStreamC_ARGS)
	Tcl: MkBufferC [$bus ReadBUF] → C-API read a val_out from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadGetNextType (MkBufferStreamC_ARGS)
	Tcl: MkTypeE [$bus ReadGetNextType] → C-API get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadGetNumItems (MkBufferStreamC_ARGS)
	Tcl: int32 [$bus ReadGetNumItems] → C-API get the number of items left in the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadItemExists (MkBufferStreamC_ARGS)
	Tcl: bool [$bus ReadItemExists] → C-API check if an item exists in the read-data-package …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadL_END (MkBufferStreamC_ARGS)
	Tcl: $bus ReadL_END → C-API END read a list-item-type from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadL_START (MkBufferStreamC_ARGS)
	Tcl: $bus ReadL_START ?buf:MkBufferC="MK_NULL"? → C-API START read a list-item-type from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadUndo (MkBufferStreamC_ARGS)
	Tcl: $bus ReadUndo → C-API undo the last MkBufferStreamC READ function call …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadBIN (MkBufferStreamC_ARGS)
	Tcl: doc_mk_tcl_BufferStreamReadBIN → C-API read a val_out from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadBOL (MkBufferStreamC_ARGS)
	Tcl: doc_mk_tcl_BufferStreamReadBOL → C-API read a val_out from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadDBL (MkBufferStreamC_ARGS)
	Tcl: doc_mk_tcl_BufferStreamReadDBL → C-API read a val_out from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadFLT (MkBufferStreamC_ARGS)
	Tcl: doc_mk_tcl_BufferStreamReadFLT → C-API read a val_out from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadI32 (MkBufferStreamC_ARGS)
	Tcl: doc_mk_tcl_BufferStreamReadI32 → C-API read a val_out from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadI64 (MkBufferStreamC_ARGS)
	Tcl: doc_mk_tcl_BufferStreamReadI64 → C-API read a val_out from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadI8 (MkBufferStreamC_ARGS)
	Tcl: doc_mk_tcl_BufferStreamReadI8 → C-API read a val_out from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadLONG (MkBufferStreamC_ARGS)
	Tcl: long [$bus ReadLONG] → C-API read the long native object from the MkBufferStreamC …
static OT_ProcRet	tclmkkernel_MkBufferStreamC_ReadSTR (MkBufferStreamC_ARGS)
	Tcl: doc_mk_tcl_BufferStreamReadSTR → C-API read a val_out from the MkBufferStreamC …

Detailed Description

MkBufferStreamC - various functions to 'read' data from a MkBufferStreamS …

Read is done at the position of MkBufferStreamS::storage->cur. After read the cur is incemented with read-sizeof characters.

Function Documentation

tclmkkernel_MkBufferStreamC_ReadALL()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadALL ( MkBufferStreamC_ARGS )

static

Tcl: MkBufferListC [$bus ReadALL ?val_inout:MkBufferListC="MK_NULL"?] → C-API
get a temporary MkBufferListC from all data in the MkBufferStreamC …

Definition at line 403 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,1,ReadALL_doc);
  MkBufferListCreateTLS_T(val_inout,10);
  OT_CHECK_OPTIONAL(OT_CHECK_BFL (val_inout,MK_NULL_YES))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MkBufferStreamReadALL (hdl, &val_inout));
  OT_retObj_SET_BFL(val_inout);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadBFL()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadBFL ( MkBufferStreamC_ARGS )

static

Tcl: MkBufferListC [$bus ReadBFL] → C-API
read a MkBufferListC from the MkBufferStreamC …

Definition at line 421 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadBFL_doc);
  OT_CHECK_NOARGS;
  MK_BFL val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadBFL (hdl, &val_out));
  OT_retObj_SET_BFL(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadBIN()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadBIN ( MkBufferStreamC_ARGS )

static

Tcl: doc_mk_tcl_BufferStreamReadBIN → C-API
read a val_out from the MkBufferStreamC …

Definition at line 538 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadBIN_doc);
  OT_CHECK_NOARGS;
  MkBinaryR val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadBIN (hdl, &val_out));
  MkBinaryR retVal = val_out;
  OT_retObj_SET(OT_GET__ME_REF_MkBinaryR(retVal));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadBOL()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadBOL ( MkBufferStreamC_ARGS )

static

Tcl: doc_mk_tcl_BufferStreamReadBOL → C-API
read a val_out from the MkBufferStreamC …

Definition at line 554 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadBOL_doc);
  OT_CHECK_NOARGS;
  MK_BOL val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadBOL (hdl, &val_out));
  OT_retObj_SET_BOL(val_out == 1);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadBUF()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadBUF ( MkBufferStreamC_ARGS )

static

Tcl: MkBufferC [$bus ReadBUF] → C-API
read a val_out from the MkBufferStreamC …

Definition at line 436 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadBUF_doc);
  OT_CHECK_NOARGS;
  MK_BUF val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadBUF (hdl, &val_out));
  OT_retObj_SET_BUF(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadDBL()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadDBL ( MkBufferStreamC_ARGS )

static

Tcl: doc_mk_tcl_BufferStreamReadDBL → C-API
read a val_out from the MkBufferStreamC …

Definition at line 569 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadDBL_doc);
  OT_CHECK_NOARGS;
  MK_DBL val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadDBL (hdl, &val_out));
  OT_retObj_SET_DBL(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadFLT()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadFLT ( MkBufferStreamC_ARGS )

static

Tcl: doc_mk_tcl_BufferStreamReadFLT → C-API
read a val_out from the MkBufferStreamC …

Definition at line 584 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadFLT_doc);
  OT_CHECK_NOARGS;
  MK_FLT val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadFLT (hdl, &val_out));
  OT_retObj_SET_FLT(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadGetNextType()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadGetNextType ( MkBufferStreamC_ARGS )

static

Tcl: MkTypeE [$bus ReadGetNextType] → C-API
get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available

Definition at line 453 of file MkBufferStreamC_tcl.c.

                                                                             {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadGetNextType_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET(OT_NEW_Mk_enum_OBJ(TypeE,MkBufferStreamReadGetNextType (hdl)));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadGetNumItems()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadGetNumItems ( MkBufferStreamC_ARGS )

static

Tcl: int32 [$bus ReadGetNumItems] → C-API
get the number of items left in the MkBufferStreamC …

Definition at line 466 of file MkBufferStreamC_tcl.c.

                                                                             {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadGetNumItems_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_I32(MkBufferStreamReadGetNumItems (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadI32()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadI32 ( MkBufferStreamC_ARGS )

static

Tcl: doc_mk_tcl_BufferStreamReadI32 → C-API
read a val_out from the MkBufferStreamC …

Definition at line 599 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadI32_doc);
  OT_CHECK_NOARGS;
  MK_I32 val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadI32 (hdl, &val_out));
  OT_retObj_SET_I32(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadI64()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadI64 ( MkBufferStreamC_ARGS )

static

Tcl: doc_mk_tcl_BufferStreamReadI64 → C-API
read a val_out from the MkBufferStreamC …

Definition at line 614 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadI64_doc);
  OT_CHECK_NOARGS;
  MK_I64 val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadI64 (hdl, &val_out));
  OT_retObj_SET_I64(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadI8()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadI8 ( MkBufferStreamC_ARGS )

static

Tcl: doc_mk_tcl_BufferStreamReadI8 → C-API
read a val_out from the MkBufferStreamC …

Definition at line 629 of file MkBufferStreamC_tcl.c.

                                                                    {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadI8_doc);
  OT_CHECK_NOARGS;
  MK_I8 val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadI8 (hdl, &val_out));
  OT_retObj_SET_I8(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadItemExists()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadItemExists ( MkBufferStreamC_ARGS )

static

Tcl: bool [$bus ReadItemExists] → C-API
check if an item exists in the read-data-package …

Definition at line 479 of file MkBufferStreamC_tcl.c.

                                                                            {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadItemExists_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_BOL(MkBufferStreamReadItemExists (hdl));
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadL_END()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadL_END ( MkBufferStreamC_ARGS )

static

Tcl: $bus ReadL_END → C-API
END read a list-item-type from the MkBufferStreamC …

Definition at line 492 of file MkBufferStreamC_tcl.c.

                                                                       {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadL_END_doc);
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MkBufferStreamReadL_END (hdl));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadL_START()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadL_START ( MkBufferStreamC_ARGS )

static

Tcl: $bus ReadL_START ?buf:MkBufferC="MK_NULL"? → C-API
START read a list-item-type from the MkBufferStreamC …

Definition at line 506 of file MkBufferStreamC_tcl.c.

                                                                         {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,1,ReadL_START_doc);
  MK_BUF buf = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_BUF (buf,MK_NULL_YES))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MkBufferStreamReadL_START (hdl, buf));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadLONG()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadLONG ( MkBufferStreamC_ARGS )

static

Tcl: long [$bus ReadLONG] → C-API
read the long native object from the MkBufferStreamC …

Definition at line 644 of file MkBufferStreamC_tcl.c.

                                                                      {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadLONG_doc);
  OT_CHECK_NOARGS;
  MK_LONG val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadLONG (hdl, &val_out));
  OT_retObj_SET_LONG(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadSTR()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadSTR ( MkBufferStreamC_ARGS )

static

Tcl: doc_mk_tcl_BufferStreamReadSTR → C-API
read a val_out from the MkBufferStreamC …

Definition at line 659 of file MkBufferStreamC_tcl.c.

                                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadSTR_doc);
  OT_CHECK_NOARGS;
  MK_STRN val_out;
  MkErrorC_Check(hdl,MkBufferStreamReadSTR (hdl, &val_out));
  OT_retObj_SET_STR(val_out);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

tclmkkernel_MkBufferStreamC_ReadUndo()

static OT_ProcRet tclmkkernel_MkBufferStreamC_ReadUndo ( MkBufferStreamC_ARGS )

static

Tcl: $bus ReadUndo → C-API
undo the last MkBufferStreamC READ function call …

Definition at line 522 of file MkBufferStreamC_tcl.c.

                                                                      {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadUndo_doc);
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MkBufferStreamReadUndo (hdl));
  OT_retObj_SET_None;
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}