libmkkernel 9.0
Loading...
Searching...
No Matches
Modules | Data Structures | Typedefs
MkBufferListC_C_API

The MkBufferListC object known as bfl or buffer-list is used to create and manage a list of MkBufferCMore...

+ Collaboration diagram for MkBufferListC_C_API:

Modules

 MkBufferListC_TOR_C_API
 various functions to create and destroy a MkBufferListC
 
 MkBufferListC_Append_C_API
 various functions to 'append' on a MkBufferListC
 
 MkBufferListC_Check_C_API
 various functions to 'check' a MkBufferListC
 
 MkBufferListC_Index_C_API
 various functions to access a MkBufferListC by 'index' …
 
 MkBufferListC_Log_C_API
 various functions to 'log' a MkBufferListC
 
 MkBufferListC_Misc_C_API
 various functions to work on a MkBufferListC
 
 MkBufferListC_Introspection_C_API
 Get information from the MkTypeS.
 
 MkBufferListC_Cast_C_API
 cast from defined and undefined instance to MkBufferListC
 

Data Structures

struct  MkBufferListS
 The CLASS used to store a list of MkBufferS items into a flat array… More...
 

Typedefs

typedef struct MkBufferListSMK_BAC
 a list of 'buffer' as last argument in function …
 
typedef const struct MkBufferListSMK_BACN
 const - a list of 'buffer' as last argument in function …
 

MkBufferListC


typedef struct MkBufferListSMK_BFL
 class-shortcut for struct MkBufferListS *, all shortcut using the XX_YYY syntax (only for public API) …
 
typedef const struct MkBufferListSMK_BFLN
 class-shortcut for const struct MkBufferListS *, all const shortcut using the XX_YYYC syntax (only for public API) …
 
typedef struct MkBufferListS MK_BFLR
 reference-shortcut for struct MkBufferListS, all shortcut using the XX_YYYR syntax (only for public API) …
 

MkBufferListC type definition

typedef struct MkBufferListS MkBufferListCR
 instance-struct-reference same as struct MkBufferListS, useable in a class-macro as: class##R
 
typedef const struct MkBufferListS MkBufferListCNR
 const instance-struct-reference same as const struct MkBufferListS, useable in a class-macro as: class##R
 
#define MkBufferListC_T   (&MK_RT_REF._MkBufferListC_T)
 instance-type as specific-instance-type, useable in a class-macro as: class##_T
 
#define MkBufferListC_TT   (MkTYP(MkBufferListC_T))
 instance-type as common-instance-type, useable in a class-macro as: class##_TT
 
#define MkBufferListST   MkBufferListC_T
 instance-type as specific-instance-type
 
#define MkBufferListSTT   (MkTYP(MkBufferListST))
 instance-type as common-instance-type (cast from MkBufferListST into MkTypeS) …
 
#define MkBufferListC_type   MK_BFL
 same as MkBufferListS but useable in a class-macro as: class##_type
 
#define MkBufferListCT_X(instance)   ( (struct MkDefTypeS *) (MkOBJ_R(instance).type) )
 cast from an instance into the specific-instance-type
 
#define MkBufferListCTT_X(instance)   (MkOBJ_R(instance).type)
 cast from an instance into the common-instance-type
 
#define MkBufferListCT_TT(typ)   ( (struct MkDefTypeS *) (typ) )
 cast from an common-instance-type into an specific-instance-type
 
#define MkBufferListC_NS   MK
 map class to namespace …
 
#define MkBufferListCTT   MkBufferListCTT
 instance-type as common-instance-type for MkBufferListC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)
 
#define MkBufferListCT   ( (struct MkDefTypeS *) MkBufferListCTT )
 instance-type as specific-instance-type for MkBufferListC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)
 

MkBufferListC signature check

bool MkBflCheck (MK_MNGN mng)
 check MkBufferListS%->Mk{ObjectS::signature} …
 
#define MkBufferListC_Check(mng)   MkBflCheck(mng)
 

MkBufferListC signature define

#define MkBufferListC_SIGNATURE   (MkObjectC_SIGNATURE ^ (2u<<10))
 
#define MkBufferListC_MASK   (((1u<<22)-1)<<10)
 

MkBufferListC cast to superclass

#define MkBufferListC_X2bfl(x)   (x)
 
#define MkBufferListC_X2obj(x)   MkOBJ(x)
 

Detailed Description

The MkBufferListC object known as bfl or buffer-list is used to create and manage a list of MkBufferC

The MkBufferListC is used to store a list of MkBufferC data into an array. In contrast to the MkBufferStreamC, each individual item can be accessed directly with the MkBufferListC.

MkBufferListS CLASS

The CLASS used to store a list of MkBufferS items into a flat array…

C-Kernel-Details

The CLASS MkBufferListS is used to store a list of MkBufferS into an MkBufferListS::data array. To access an MkBufferS item use:

‍0 <= index < MkBufferListS::cursize

A new MkBufferListS is always preallocated with the predefined ILS-storage (MkBufferListS::bls), but can switch to a MALLOC-storage if the storage requirements of the user exceed the predefined ILS-storage-size (MkBufferListS_bls_size).

‍A MkBufferListS never run out of storage.

See also
MkBufferC, MkBufferStreamC

MkBufferListS CTOR / DTOR

command alias
(constructor) MK_BFL MkBufferListCreate(MK_NUM size) no
void MkBufferListDelete(MK_BFL bfl) no

Macro Definition Documentation

◆ MkBufferListC_Check

#define MkBufferListC_Check (   mng)    MkBflCheck(mng)

Definition at line 9123 of file kernel_mk.h.

◆ MkBufferListC_MASK

#define MkBufferListC_MASK   (((1u<<22)-1)<<10)

Definition at line 9060 of file kernel_mk.h.

◆ MkBufferListC_NS

#define MkBufferListC_NS   MK

map class to namespace …

Definition at line 9099 of file kernel_mk.h.

◆ MkBufferListC_SIGNATURE

#define MkBufferListC_SIGNATURE   (MkObjectC_SIGNATURE ^ (2u<<10))

Definition at line 9059 of file kernel_mk.h.

◆ MkBufferListC_T

#define MkBufferListC_T   (&MK_RT_REF._MkBufferListC_T)

instance-type as specific-instance-type, useable in a class-macro as: class##_T

Definition at line 9083 of file kernel_mk.h.

◆ MkBufferListC_TT

#define MkBufferListC_TT   (MkTYP(MkBufferListC_T))

instance-type as common-instance-type, useable in a class-macro as: class##_TT

Definition at line 9085 of file kernel_mk.h.

◆ MkBufferListC_type

#define MkBufferListC_type   MK_BFL

same as MkBufferListS but useable in a class-macro as: class##_type

Definition at line 9091 of file kernel_mk.h.

◆ MkBufferListC_X2bfl

#define MkBufferListC_X2bfl (   x)    (x)

Definition at line 9068 of file kernel_mk.h.

◆ MkBufferListC_X2obj

#define MkBufferListC_X2obj (   x)    MkOBJ(x)

Definition at line 9069 of file kernel_mk.h.

◆ MkBufferListCT

#define MkBufferListCT   ( (struct MkDefTypeS *) MkBufferListCTT )

instance-type as specific-instance-type for MkBufferListC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)

Definition at line 9103 of file kernel_mk.h.

◆ MkBufferListCT_TT

#define MkBufferListCT_TT (   typ)    ( (struct MkDefTypeS *) (typ) )

cast from an common-instance-type into an specific-instance-type

Definition at line 9097 of file kernel_mk.h.

◆ MkBufferListCT_X

#define MkBufferListCT_X (   instance)    ( (struct MkDefTypeS *) (MkOBJ_R(instance).type) )

cast from an instance into the specific-instance-type

Definition at line 9093 of file kernel_mk.h.

◆ MkBufferListCTT

#define MkBufferListCTT   MkBufferListCTT

instance-type as common-instance-type for MkBufferListC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)

Definition at line 9101 of file kernel_mk.h.

◆ MkBufferListCTT_X

#define MkBufferListCTT_X (   instance)    (MkOBJ_R(instance).type)

cast from an instance into the common-instance-type

Definition at line 9095 of file kernel_mk.h.

◆ MkBufferListST

#define MkBufferListST   MkBufferListC_T

instance-type as specific-instance-type

Definition at line 9087 of file kernel_mk.h.

◆ MkBufferListSTT

#define MkBufferListSTT   (MkTYP(MkBufferListST))

instance-type as common-instance-type (cast from MkBufferListST into MkTypeS) …

Definition at line 9089 of file kernel_mk.h.

Typedef Documentation

◆ MK_BAC

typedef struct MkBufferListS* MK_BAC

a list of 'buffer' as last argument in function …

Definition at line 3083 of file kernel_mk.h.

◆ MK_BACN

typedef const struct MkBufferListS* MK_BACN

const - a list of 'buffer' as last argument in function …

Definition at line 3088 of file kernel_mk.h.

◆ MK_BFL

typedef struct MkBufferListS* MK_BFL

class-shortcut for struct MkBufferListS *, all shortcut using the XX_YYY syntax (only for public API) …

Definition at line 2957 of file kernel_mk.h.

◆ MK_BFLN

typedef const struct MkBufferListS* MK_BFLN

class-shortcut for const struct MkBufferListS *, all const shortcut using the XX_YYYC syntax (only for public API) …

Definition at line 2960 of file kernel_mk.h.

◆ MK_BFLR

typedef struct MkBufferListS MK_BFLR

reference-shortcut for struct MkBufferListS, all shortcut using the XX_YYYR syntax (only for public API) …

Definition at line 2963 of file kernel_mk.h.

◆ MkBufferListCNR

typedef const struct MkBufferListS MkBufferListCNR

const instance-struct-reference same as const struct MkBufferListS, useable in a class-macro as: class##R

Definition at line 9081 of file kernel_mk.h.

◆ MkBufferListCR

typedef struct MkBufferListS MkBufferListCR

instance-struct-reference same as struct MkBufferListS, useable in a class-macro as: class##R

Definition at line 9079 of file kernel_mk.h.

Function Documentation

◆ MkBflCheck()

bool MkBflCheck ( MK_MNGN  mng)
inline

check MkBufferListS%->Mk{ObjectS::signature} …

Returns
TRUE on valid bfl and FALSE an invalid bfl

Definition at line 9118 of file kernel_mk.h.

+ Here is the caller graph for this function: