Sq3FileC - low level definition, access and cast … More...

Collaboration diagram for Sq3FileC_Class_Define_C_API:

Sq3FileC - type definition
typedef struct Sq3FileS	Sq3FileCR
	*instance-struct-reference* same as `struct Sq3FileS`, useable in a class-macro as: `class##R` …

typedef const struct Sq3FileS	Sq3FileCNR
	const *instance-struct-reference* same as `const struct Sq3FileS`, useable in a class-macro as: `class##R` …

__thread MK_TYP	Sq3FileC_TT
	*class* as MkTypeDefS-class-type …

#define	Sq3FileC_T ( (struct MkTypeDefS *) (Sq3FileC_TT) )
	*class* as MkTypeDefS-class-type (cast from `Sq3FileC_TT` into `MkTypeS`) …

#define	Sq3FileST Sq3FileC_T
	*instance-type* as MkTypeDefS-class-type …

#define	Sq3FileSTT (MkTYP(Sq3FileST))
	*instance-type* as MkTypeS-class-type (cast from `Sq3FileST` into `MkTypeS`) …

#define	Sq3FileC_type SQ3_FILE
	same as Sq3FileS but useable in a class-macro as: `class##_type` …

#define	Sq3FileCT_X(instance)
	cast from an instance into the MkTypeDefS-class-type …

#define	Sq3FileCTT_X(instance)
	cast from an instance into the MkTypeS-class-type …

#define	Sq3FileCT_TT(typ)
	cast from an MkTypeS-class-type into an MkTypeDefS-class-type …

#define	Sq3FileC_NS SQ3
	map class to namespace …

#define	Sq3FileCTT Sq3FileCTT
	*class* as MkTypeS-class-type for `Sq3FileC` in the Target-Programming-Language (TPL) …

#define	Sq3FileCT ( (struct MkTypeDefS *) Sq3FileCTT )
	*class* as MkTypeDefS-class-type for `Sq3FileC` in the Target-Programming-Language (TPL) …

Sq3FileC - signature check
static bool	Sq3FileCheck (MK_MNGN mng)
	check Sq3FileS -> MkObjectS::signature …

static bool	Sq3FileCheckO (MK_OBJN obj)
	check Sq3FileS -> MkObjectS::signature …

#define	Sq3FileC_Check(mng)

Sq3FileC - cast from a defined or a undefined instance
static SQ3_FILE	Sq3File (MK_MNG mng)
	cast a unknown-object into an Sq3FileS pointer or NULL if not possible

static SQ3_FILEN	Sq3FileN (MK_MNGN mng)
	(const) cast a unknown-object into an Sq3FileS pointer or NULL if not possible

#define	Sq3FileRaise(_file)
	raise an error if class-instance is not valid

#define	Sq3FILE_R(x)
	cast a known-object into an Sq3FileS reference

#define	Sq3FILE(x)
	cast a known-object into an Sq3FileS pointer

Sq3FileC - Sq3FileC_Class_Define_C_API - function
SQ3_FILE	Sq3FileP (MK_MNG mng)
	Non-inline replacement for Sq3File …

MK_BOOL	Sq3FileCheckP (MK_MNGN mng)
	Non-inline replacement for Sq3FileCheck …

MK_BOOL	Sq3FileCheckOP (MK_OBJN obj)
	Non-inline replacement for Sq3FileCheckO …

SQ3_FILEN	Sq3FileNP (MK_MNGN mng)
	Non-inline replacement for Sq3FileN …

Sq3FileC - signature define
#define	Sq3FileC_SIGNATURE (MkObjectC_SIGNATURE ^ (21u<<10))

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

Sq3FileC - cast to superclass
#define	Sq3FileC_X2file(x)

#define	Sq3FileC_X2obj(x)

Detailed Description

Sq3FileC - low level definition, access and cast …

Macro Definition Documentation

◆ Sq3FILE

#define Sq3FILE ( x )

Value:

(&Sq3FILE_R(x))

Sq3FILE_R

#define Sq3FILE_R(x)

cast a known-object into an Sq3FileS reference

Definition Sq3FileC_def_sq3.h:169

cast a known-object into an Sq3FileS pointer

Definition at line 171 of file Sq3FileC_def_sq3.h.

◆ Sq3FILE_R

#define Sq3FILE_R ( x )

Value:

(*(x)).super.file

cast a known-object into an Sq3FileS reference

Definition at line 169 of file Sq3FileC_def_sq3.h.

◆ Sq3FileC_Check

#define Sq3FileC_Check ( mng )

Value:

Sq3FileCheck(mng)

Sq3FileCheck

static bool Sq3FileCheck(MK_MNGN mng)

check Sq3FileS -> MkObjectS::signature …

Definition Sq3FileC_def_sq3.h:125

Definition at line 138 of file Sq3FileC_def_sq3.h.

◆ Sq3FileC_MASK

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

Definition at line 68 of file Sq3FileC_def_sq3.h.

◆ Sq3FileC_NS

#define Sq3FileC_NS SQ3

map class to namespace …

Definition at line 106 of file Sq3FileC_def_sq3.h.

◆ Sq3FileC_SIGNATURE

#define Sq3FileC_SIGNATURE (MkObjectC_SIGNATURE ^ (21u<<10))

Definition at line 67 of file Sq3FileC_def_sq3.h.

◆ Sq3FileC_T

#define Sq3FileC_T ( (struct MkTypeDefS *) (Sq3FileC_TT) )

class as MkTypeDefS-class-type (cast from Sq3FileC_TT into MkTypeS) …

Definition at line 92 of file Sq3FileC_def_sq3.h.

◆ Sq3FileC_type

#define Sq3FileC_type SQ3_FILE

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

Definition at line 98 of file Sq3FileC_def_sq3.h.

◆ Sq3FileC_X2file

#define Sq3FileC_X2file ( x )

Value:

(x)

Definition at line 76 of file Sq3FileC_def_sq3.h.

◆ Sq3FileC_X2obj

#define Sq3FileC_X2obj ( x )

Value:

MkOBJ(x)

MkOBJ

#define MkOBJ(x)

Definition at line 77 of file Sq3FileC_def_sq3.h.

◆ Sq3FileCT

#define Sq3FileCT ( (struct MkTypeDefS *) Sq3FileCTT )

class as MkTypeDefS-class-type for Sq3FileC in the Target-Programming-Language (TPL) …

Definition at line 110 of file Sq3FileC_def_sq3.h.

◆ Sq3FileCT_TT

#define Sq3FileCT_TT ( typ )

Value:

( (struct MkTypeDefS *) (typ) )

MkTypeDefS

MkTypeDefS::typ

struct MkTypeS typ

cast from an MkTypeS-class-type into an MkTypeDefS-class-type …

Definition at line 104 of file Sq3FileC_def_sq3.h.

◆ Sq3FileCT_X

#define Sq3FileCT_X ( instance )

Value:

( (struct MkTypeDefS *) (MkOBJ_R(instance).type) )

MkOBJ_R

#define MkOBJ_R(x)

cast from an instance into the MkTypeDefS-class-type …

Definition at line 100 of file Sq3FileC_def_sq3.h.

◆ Sq3FileCTT

#define Sq3FileCTT Sq3FileCTT

class as MkTypeS-class-type for Sq3FileC in the Target-Programming-Language (TPL) …

Definition at line 108 of file Sq3FileC_def_sq3.h.

◆ Sq3FileCTT_X

#define Sq3FileCTT_X ( instance )

Value:

(MkOBJ_R(instance).type)

cast from an instance into the MkTypeS-class-type …

Definition at line 102 of file Sq3FileC_def_sq3.h.

◆ Sq3FileRaise

#define Sq3FileRaise ( _file )

Value:

    if (!_MkCheckX(Sq3FileC,_file)) { \
    MkErrorSetC_1E("'Sq3FileC' hdl is NULL"); \
    goto error ; \
  }

raise an error if class-instance is not valid

Definition at line 163 of file Sq3FileC_def_sq3.h.

  #define Sq3FileRaise(_file) if (!_MkCheckX(Sq3FileC,_file)) { \
    MkErrorSetC_1E("'Sq3FileC' hdl is NULL"); \
    goto error ; \
  }

◆ Sq3FileST

#define Sq3FileST Sq3FileC_T

instance-type as MkTypeDefS-class-type …

Definition at line 94 of file Sq3FileC_def_sq3.h.

◆ Sq3FileSTT

#define Sq3FileSTT (MkTYP(Sq3FileST))

instance-type as MkTypeS-class-type (cast from Sq3FileST into MkTypeS) …

Definition at line 96 of file Sq3FileC_def_sq3.h.

Typedef Documentation

◆ Sq3FileCNR

typedef const struct Sq3FileS Sq3FileCNR

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

Definition at line 88 of file Sq3FileC_def_sq3.h.

◆ Sq3FileCR

typedef struct Sq3FileS Sq3FileCR

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

Definition at line 86 of file Sq3FileC_def_sq3.h.

Function Documentation

◆ Sq3File()

static SQ3_FILE Sq3File ( MK_MNG mng )

inlinestatic

cast a unknown-object into an Sq3FileS pointer or NULL if not possible

Definition at line 150 of file Sq3FileC_def_sq3.h.

                                         {
    return (Sq3FileCheck(mng) ? (SQ3_FILE)mng : NULL);
  }

Here is the caller graph for this function:

◆ Sq3FileCheck()

static bool Sq3FileCheck ( MK_MNGN mng )

inlinestatic

check Sq3FileS -> MkObjectS::signature …

Returns: TRUE on valid file and FALSE an invalid file

Definition at line 125 of file Sq3FileC_def_sq3.h.

                                            {
    return MkSanitizeCheck(Sq3FileC,mng);
  }

Here is the caller graph for this function:

◆ Sq3FileCheckO()

static bool Sq3FileCheckO ( MK_OBJN obj )

inlinestatic

check Sq3FileS -> MkObjectS::signature …

Returns: TRUE on valid file and FALSE an invalid file

Definition at line 133 of file Sq3FileC_def_sq3.h.

                                             {
    return MkSanitizeCheckO(Sq3FileC,obj);
  }

◆ Sq3FileCheckOP()

MK_BOOL Sq3FileCheckOP ( MK_OBJN obj )

Non-inline replacement for Sq3FileCheckO …

◆ Sq3FileCheckP()

MK_BOOL Sq3FileCheckP ( MK_MNGN mng )

Non-inline replacement for Sq3FileCheck …

◆ Sq3FileN()

static SQ3_FILEN Sq3FileN ( MK_MNGN mng )

inlinestatic

(const) cast a unknown-object into an Sq3FileS pointer or NULL if not possible

Definition at line 158 of file Sq3FileC_def_sq3.h.

                                            {
    return (Sq3FileCheck(mng) ? (SQ3_FILEN)mng : NULL);
  }

◆ Sq3FileNP()

SQ3_FILEN Sq3FileNP ( MK_MNGN mng )

Non-inline replacement for Sq3FileN …

◆ Sq3FileP()

SQ3_FILE Sq3FileP ( MK_MNG mng )

Non-inline replacement for Sq3File …

Variable Documentation

◆ Sq3FileC_TT

__thread MK_TYP Sq3FileC_TT

extern

class as MkTypeDefS-class-type …

Sq3FileC - type definition

Sq3FileC - signature check

Sq3FileC - cast from a defined or a undefined instance

Sq3FileC - Sq3FileC_Class_Define_C_API - function

Sq3FileC - signature define

Sq3FileC - cast to superclass

Detailed Description

Macro Definition Documentation

◆ Sq3FILE

◆ Sq3FILE_R

◆ Sq3FileC_Check

◆ Sq3FileC_MASK

◆ Sq3FileC_NS

◆ Sq3FileC_SIGNATURE

◆ Sq3FileC_T

◆ Sq3FileC_type

◆ Sq3FileC_X2file

◆ Sq3FileC_X2obj

◆ Sq3FileCT

◆ Sq3FileCT_TT

◆ Sq3FileCT_X

◆ Sq3FileCTT

◆ Sq3FileCTT_X

◆ Sq3FileRaise

◆ Sq3FileST

◆ Sq3FileSTT

Typedef Documentation

◆ Sq3FileCNR

◆ Sq3FileCR

Function Documentation

◆ Sq3File()

◆ Sq3FileCheck()

◆ Sq3FileCheckO()

◆ Sq3FileCheckOP()

◆ Sq3FileCheckP()

◆ Sq3FileN()

◆ Sq3FileNP()

◆ Sq3FileP()

Variable Documentation

◆ Sq3FileC_TT